Pinrail Docs

Pinrail Docs

Public documentation for Pinrail developers, terminal operators, and partner teams.

Documentation Sections

The docs site is organized into four primary sections:

  • Main
  • Programming
  • TMS
  • Development

What Each Section Covers

  • Main contains the introduction and glossary.
  • Programming contains vendor-specific ATM programming pages for Hyosung, Genmega, and Triton.
  • TMS contains operator-facing guidance for account and terminal workflows.
  • Development contains the API, webhooks, and RSS feed guidance.

Current Public Scope

This public documentation pass currently emphasizes:

  • authenticated tenant-facing APIs
  • webhook and syndication planning
  • TMS workflows and visibility
  • ATM programming documentation by vendor
  • shared terminology and operator language

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 tenant 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 examples once the first public flows are locked

Deployment

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

Introduction

High-level introduction to Pinrail, the public docs site, and the current customer-facing product surface.

On this page

Documentation SectionsWhat Each Section CoversCurrent Public ScopeSource Of TruthDeployment