openapi/README.md
OpenAPI Catalog
Contratos OpenAPI 3.x de Kodenix Verify OTP.
Vista Swagger
Contratos disponibles
| Contrato | Archivo | Responsabilidad |
|---|---|---|
| OTP Public API | otp-public-api.yaml | Operación OTP usada por SDKs e integradores. |
| Licensing API | licensing-api.yaml | Licencias, entitlements, cuotas y control de uso. |
| Admin API | admin-api.yaml | Administración de clientes, aplicaciones, reglas, branding y proveedores. |
| Provider Internal API | provider-internal-api.yaml | Contrato interno para orquestar WhatsApp, SMS y Email. |
| Analytics API | analytics-api.yaml | Métricas, uso, consumo y reportes transaccionales. |
| Webhooks API | webhooks-api.yaml | Eventos enviados al backend del cliente. |
Criterios comunes
- Formato: OpenAPI 3.x.
- Autenticación pública server-to-server: API Key.
- Autenticación SDK runtime: Bearer sdkToken temporal.
- Respuestas de error: formato normalizado definido en Catálogo de errores.
- Conteo transaccional: definido en Transaction Counting & Billing.
- Licenciamiento: definido en Licensing & Usage Control.