LandingSwagger UI
README.md

Kodenix Verify OTP

Repositorio oficial de especificaciones, contratos y documentación de integración de Kodenix Verify OTP.

Arquitectura de repositorios

  • Documentación: kodenix-verify-otp-spec (este repositorio).
  • Android SDK: repositorio privado independiente con otp-core, otp-core-ktx, otp-ui-views y otp-ui-compose; su integración pública se documenta aquí.
  • iOS y Web tendrán repositorios independientes.
  • sdk/: contratos comunes y por plataforma.
  • openapi/: contratos de las APIs.
  • docs/: documentación central, seguridad, operación y guías de integración.
  • docs-html/: sitio generado; no se edita manualmente.
  • backend/, admin/, operations/ y qa/: handoff y especificaciones por área.

No se usan submódulos. Cada SDK mantiene su propio versionado y ciclo de releases; después de cambiar un SDK debe ejecutarse una tarea separada de actualización de este repositorio documental.

Alcance del paquete

  • SDK Web, Android e iOS.
  • API pública OTP.
  • API Admin.
  • API de licenciamiento.
  • API interna de proveedores.
  • API de analytics/usage.
  • Webhooks.
  • Licenciamiento por cliente, aplicación, ambiente, plataforma y URL/app nativa.
  • Cobro por OTP enviado.
  • Control para impedir reutilizar una licencia/API key en sitios no autorizados.
  • Fallback WhatsApp → SMS → Email.
  • Target opcional en inicialización del SDK: teléfono/email puede venir desde el integrador o capturarse en la UI del SDK.
  • Seguridad, auditoría, infraestructura, runbooks, QA y conteo transaccional.

Navegación principal

  1. Gobierno de documentación
  2. Alcance funcional
  3. Requerimientos
  4. Licenciamiento y control de uso
  5. Conteo transaccional y facturación
  6. Seguridad
  7. Fallback y disponibilidad de canales
  8. Contrato API
  9. Máquina de estados
  10. Modelo de datos
  11. Infraestructura
  12. Observabilidad y auditoría
  13. Catálogo de errores
  14. Webhooks
  15. SLA y disponibilidad
  16. Versionado
  17. Superficie de publicación
  18. Guía de integración Android

APIs

Diagramas

Diagramas fuente

Backend handoff

SDK contracts

Android 0.1.0 usa una única fachada KodenixOtp.create(...): configuración normal selecciona el transporte HTTP real y mockEnabled selecciona el mock fuera de producción. No existe un método público separado para mocks.

El target puede contener teléfono, email, ambos o estar ausente. WhatsApp/SMS requieren teléfono y Email requiere correo; Views y Compose respetan el canal preferido de la sesión. La captura interna de un target ausente todavía está pendiente.

Las UIs y KTX incluyen sus dependencias core transitivamente: declare solo otp-ui-views, otp-core-ktx u otp-ui-compose según corresponda. Views con coroutines requiere Views + KTX. Mantenga todos los artefactos en la misma versión.

Desarrollo de documentación

npm install
npm run docs:build
npm run docs:check

Los Markdown son la fuente de verdad. npm run docs:build regenera docs-html y npm run docs:check comprueba la guía Android contra el README rápido, las coordenadas Maven, enlaces y símbolos esenciales documentados. Para compararla además con un checkout local del SDK, defina KODENIX_ANDROID_SDK_PATH antes de ejecutar la validación.

Administración

Operaciones

QA

Postman

Seguridad documental

Los valores incluidos en este repositorio son ejemplos de especificación. No forman parte del material autorizado: secretos reales, tokens productivos, credenciales de proveedores, llaves privadas o URLs internas sensibles.