Pinrail Docs

Overview

Pinrail Docs is the public integration surface for external developers, sponsor-bank partners, and terminal operators.

Use this site for:

• environment setup and authentication planning
• terminal-management API concepts
• provisioning and connector workflow guidance
• webhook event handling guidance
• customer-facing SDK and example-app entry points

Source of Truth

Public contracts are owned by the service repos first and then published here once they are stable for external consumers.

• pinrail-platform owns the operator and terminal-management API surface
• pinrail-shared-contracts is the long-term home for reusable public schemas
• pinrail-sdk-* repos will consume the stable contracts published from the platform
• pinrail-customer-examples will hold runnable customer examples once the first public flows are locked

Current Public Scope

The current documentation pass focuses on the pieces that matter most to early adopters:

• terminal inventory and management concepts
• connector and routing visibility
• provisioning export workflows for terminal configuration
• webhook lifecycle expectations
• authentication boundaries and environment separation

Detailed generated reference remains a follow-up item once the public OpenAPI contract is finalized.

Deployment

This site is built from Markdown and MDX stored in GitHub and deployed to Cloudflare Workers using OpenNext.