OpenAPI
Публичные артефакты OpenAPI публикуются вместе с этим зеркалом документации.
Поверхности
Публикуются Runtime (устройство/SDK) и Vendor Partner (подмножество Management для продавцов ключей). Полный Management admin OpenAPI и Relay Host OpenAPI не публикуются целиком.
Загрузки
| Артефакт | Формат | Ссылка |
|---|---|---|
| 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
URL сервера-заглушка: https://runtime.example.com. Замените на ваш Runtime base URL.
Vendor Partner
Отфильтрованное подмножество Management для автоматизации вендора (продавец ключей): licenses, devices, customers, Vendor Commerce, service accounts.
- Host-заглушка:
https://management-api.example.com→ замените наmanagement-api.<domain> - Auth: Bearer токен service account (только локально; не коммитьте live credentials)
- Не входит: Platform Admin (
/api/v1/platform/*), Platform Billing / PBL (/api/v1/billing/*), inbound PSP webhook routes
Связанные каталоги
Перегенерация (операторы платформы)
Из private platform repository:
.\scripts\export-openapi.ps1 # при необходимости обновить openapi/*.yaml
.\tools\docs-public\prepare-artifacts.ps1
.\tools\docs-public\sync.ps1 -Apply