Skip to main content

Sfey API specifications (v3) — platform guide

This guide orients readers across the Sfey API specifications (v3) documentation set and the linked OpenAPI explorers.

Structure

The v3 book is organised by product area (for example TPS Device API). Each section contains changelog notes, terminal registration flows, and operation-level reference material.

NeedGo to
Device API changelogBrowse API v3.0 → TPS Device API → Changelog in the sidebar
Interactive explorerAPI Reference — select the v3 spec from the tab switcher
AFC v2.2 legacyAFC API guide

Explorer vs guides

  • Guides explain registration, key management, and operational context.
  • API Reference provides the machine-readable contract with Try It for staff-authorized environments.
info

Try It requests execute on SfeyDocs infrastructure, not from your browser, so partner and production endpoints see consistent egress.

Access

Library visibility and partner grants are configured in Admin → Projects. The navbar + Add source action creates a registry entry; fine-grained access is assigned afterward in the governance console.