Todo lo que tus desarrolladores necesitan
La documentación completa vivirá en docs.kirkyapp.com. Mientras ese sitio no sea público, empieza aquí: el quickstart y el modelo de seguridad ya están listos.
Lo que cubre la documentación
- Disponible
Quickstart
Del script a la primera respuesta dentro de tu app.
LeerEncontrarás
- Los tres pasos de instalación
- Entornos Test y Live
- Solución de problemas
- Próximamente
Identidad y tokens
Cómo tu backend le dice a Kirky quién es el usuario.
Encontrarás
- Ejemplos de firma ES256 para Node, Python, PHP, .NET y Java
- Claims, vencimiento y rotación de llaves
- Roles y permisos
- Próximamente
Referencia del SDK
Cada opción y método del SDK web.
Encontrarás
- Opciones y eventos de init()
- Personalizar el widget
- Modo mock para desarrollo local
- Próximamente
Endpoints y OpenAPI
Dale a Kirky acceso de lectura a tus datos en vivo, por rol.
Encontrarás
- Importar un archivo OpenAPI
- Escribir descripciones que Kirky entienda
- Endpoints de escritura y confirmaciones
- Próximamente
Fuentes de conocimiento
Los documentos de los que responde Kirky, y cómo se mantienen al día.
Encontrarás
- PDF, Word y escaneos
- Drive, SharePoint y Dropbox
- Carga masiva por API o CLI
- Próximamente
Reglas de Centinela
Avisos antes de guardar un dato fuera de lo normal.
Encontrarás
- sentinel.check() antes de guardar
- Etiquetado de formularios sin código
- Revisión nocturna en Business
- Próximamente
API de administración y CLI
Automatiza tu espacio de trabajo desde scripts y CI.
Encontrarás
- Llaves de API para administradores, nunca para usuarios finales
- Subir fuentes desde la CLI
- Exportar uso y auditoría
- Disponible
Modelo de seguridad
A dónde van los datos, quién puede leerlos y qué nunca sale de tu app.
LeerEncontrarás
- Llamadas de datos desde el navegador
- Citas verificadas
- Región y subprocesadores
El SDK en una pantalla
Un objeto global y unos cuantos métodos. La referencia completa llega con el sitio de documentación.
- init(options)
- Inicia el widget con tu tenant, el token del usuario y, si quieres, getAuthHeaders, lang y un nonce de CSP.
- ready()
- Una promesa que se resuelve cuando el widget terminó de cargar. Las llamadas previas quedan en cola.
- identify(token)
- Cambia el usuario con sesión sin recargar la página.
- logout()
- Borra la conversación y la sesión. Úsalo en computadoras compartidas.
- sentinel.check(record)
- Le pregunta a Centinela por un registro antes de guardarlo. Responde en milisegundos y nunca bloquea.
- diagnostics()
- Reporta lo que ve el SDK: versión, CSP, estado del token y los últimos errores.
// opciones de init(), con sus valores por defecto Kirky.init({ tenant: "tn_4f7k2q", token, // ES256, ≤ 5 min getAuthHeaders, // optional lang: "es", // or "en" mode: "live", // or "mock" nonce, // strict CSP debug: false, }); await Kirky.ready();