Kodenix Verify

OTP SDK Specification

Documentación técnica para SDK OTP Web, Android e iOS, APIs, licenciamiento, seguridad, fallback WhatsApp → SMS → Email, conteo de transacciones, operación, QA y diagramas.

GitHub Ready

OpenAPI / Swagger

Mermaid Diagrams

Licensing & Usage Control

Entrada principal

READMEInicio general, estructura y navegación del paquete. ManifestInventario completo de documentos, APIs, diagramas y anexos. Documentation GovernanceFuente oficial de cada tema.

Documentación funcional y técnica

Functional ScopeAlcance, capacidades, límites y responsabilidades. RequirementsRequerimientos funcionales, no funcionales y de seguridad. Licensing & Usage ControlLicencias, entitlements, URL/app binding, cuotas y restricciones. Transaction Counting & BillingConteo por OTP enviado, reglas de cobro, cuotas y métricas. Security SpecificationAPI keys, sdkToken, allowed origins, package binding y hardening. Fallback & Channel AvailabilityWhatsApp primario, SMS/Email alternos, canal caído y target faltante. Error CatalogErrores normalizados para SDK, API, proveedores y operación. WebhooksEventos hacia el backend del cliente.

APIs y Swagger

Swagger UIVisualizador interactivo de contratos OpenAPI. OpenAPI IndexCatálogo de archivos YAML. OTP Public APIContrato principal de operación OTP para SDK e integradores. Admin APIAdministración de clientes, apps, reglas, branding y proveedores. Licensing APILicencias, entitlements, cuotas, uso y validaciones. Webhooks APIEventos enviados al backend del cliente.

Diagramas y operación

DiagramsDiagramas Mermaid embebidos para visualización en repositorio. Operations RunbookRunbooks, incident response, outage, monitoreo y soporte. Backend HandoffImplementación backend, servicios, configuraciones y reglas. SDK ContractsInicialización y callbacks para Web, Android e iOS. QA Test CasesCasos funcionales, seguridad y criterios de aceptación. PostmanColección de pruebas manuales y automatizadas.