OpenAPI Specifications (Internal)
Zyntem's API surface is split across three persona-scoped specs. The internal docs site serves the internal spec only (admin / portal / ops / billing webhooks). The other two are served from the public docs site.
Download
- openapi.internal.yaml — admin/ops/portal/billing webhooks
The public-facing specs live on the public docs site:
openapi.public.yaml— developer / ISV cloud APIopenapi.management.yaml— embedded-local provisioning plane
Included endpoint groups (internal spec)
| Group | Description |
|---|---|
| Admin | Batch processing and operations |
| Retry Queue | Failed transaction retry |
| Fleet | Agent telemetry and fleet metrics |
| Batch | Background batch schedules |
| API Keys | Customer self-service key management |
| Subscriptions | Billing subscription management |
| Onboarding | Account onboarding status |
| Usage | Usage metering and tier status |
| Accounts | Account self-service (status/export/delete) |
| GDPR | Consent records and Art. 15 / Art. 17 endpoints |
| Webhooks | External webhook receivers (Stripe, Italy SDI) |
| Stripe | Stripe billing event processing |
Viewing the specs
You can view any spec interactively using:
- Swagger Editor — paste the YAML content
- Redocly — point to the hosted URL
- Local tools:
npx @redocly/cli preview-docs docs/openapi.internal.yaml
Source
The three specs are maintained at docs/openapi.public.yaml,
docs/openapi.management.yaml, and docs/openapi.internal.yaml. Changes are
reflected here on every deploy via scripts/split-openapi.js, which rewrites
the servers: block to the deploy environment and copies each spec into the
appropriate Docusaurus static/ directory.