OpenAPI

Public OpenAPI artifacts are published with this documentation mirror.

Surfaces

Runtime (device/SDK) and Vendor Partner (Management subset for key sellers) are published. Full Management admin OpenAPI and Relay Host OpenAPI are not published as wholesale dumps.

Downloads

Artifact	Format	Link
Runtime OpenAPI	YAML	/artifacts/openapi/runtime.v1.yaml
Runtime OpenAPI	JSON	/artifacts/openapi/runtime.v1.json
Runtime Postman	JSON	/artifacts/postman/runtime.v1.postman_collection.json
Partner OpenAPI	YAML	/artifacts/openapi/partner.management.v1.yaml
Partner OpenAPI	JSON	/artifacts/openapi/partner.management.v1.json
Partner Postman	JSON	/artifacts/postman/partner.management.v1.postman_collection.json

Runtime

Server URL placeholder: https://runtime.example.com. Replace with your Runtime base URL.

Vendor Partner

Filtered Management subset for Vendor (key seller) automation: licenses, devices, customers, Vendor Commerce, service accounts.

• Placeholder host: https://management-api.example.com → replace with management-api.<domain>
• Auth: service-account Bearer token (set locally; never commit live credentials)
• Not included: Platform Admin (/api/v1/platform/*), Platform Billing / PBL (/api/v1/billing/*), inbound PSP webhook routes

Related catalogs

• Error catalog
• Webhook event catalog
• API Reference

Regenerating (platform operators)

From the private platform repository:

.\scripts\export-openapi.ps1   # refresh openapi/*.yaml when needed
.\tools\docs-public\prepare-artifacts.ps1
.\tools\docs-public\sync.ps1 -Apply