Getting Started
Set up your first Pinrail integration and find the public docs boundaries.
Before You Integrate
Make sure you know:
- which Pinrail environment you are targeting
- which terminal-management workflows you need first
- which webhook events and credentials your integration requires
- whether you need API access, provisioning exports, or both
Integration Paths
Most early integrations fit one of these paths:
- Terminal-management integration
Use the terminal, connector, and provisioning resources exposed by
pinrail-platform. - Event-driven integration Consume Pinrail webhooks and reconcile terminal, connector, or settlement state inside your system.
- SDK-led integration Start from the language SDK or example app once the public client libraries are published.
Public Documentation Boundaries
This repo is the published content source for docs.pinrail.com.
- Write customer-facing docs under
content/docs - Keep examples scrubbed and runnable
- Avoid internal-only architecture, compliance, or operational content
Current Public Surfaces
The current operator-facing API areas under documentation are:
- terminals and terminal detail
- connector inventory and connector run status
- terminal groups and routing-policy fanout
- provisioning exports and provisioning job history
- settlement workflow concepts for ACH batch handling
Still Stabilizing
These areas are intentionally documented at a concept level until the contract hardens:
- generated OpenAPI reference from
pinrail-platform - SDK quickstarts for Node, Python, Go, and Ruby
- signed webhook delivery examples
- customer-ready example apps from
pinrail-customer-examples