API de ORYKSA, webhooks y portal developer
Conecta apps y sistemas con tu empleado de IA con claves de API y webhooks.
La API de ORYKSA permite a los desarrolladores usar tu empleado de IA en sus propias apps, webs y sistemas: enviar mensajes de clientes y recibir respuestas, mantener sincronizado el conocimiento (Brain), informar conversiones y recibir webhooks cuando la IA responde o crea una reserva.
Por dónde empezar: documentación completa en inglés, portugués y español en developer.oryksa.com, con archivo OpenAPI, colección Postman y consola "Try it".
Crear una clave de API
- Entra en developer.oryksa.com con tu cuenta ORYKSA y abre Keys.
- Escribe un nombre (por ejemplo "app iOS") y pulsa Create key.
- Copia la clave enseguida. Por seguridad solo se muestra una vez.
Revoca una clave cuando quieras: las apps que la usan dejan de funcionar al momento. Guarda las claves en un servidor, nunca dentro de una web o una app.
Webhooks
En el mismo lugar añade la dirección (https) que debe recibir los eventos y elige los eventos: mensaje respondido, reserva creada, límite del plan alcanzado, conocimiento actualizado. Guarda el secreto de firma que se muestra una vez y usa Test para comprobar el envío.
Conversiones
Tu web o app puede avisar a ORYKSA cuando una conversación dio resultado con POST /v1/conversions (venta, lead, registro o reserva). Recibes una alerta, y ORYKSA puede responderte sobre ello en el chat del panel.
Planes
La API es un canal web, como el chat del sitio. Cada respuesta de la IA cuenta como una interacción del plan, con los mismos límites que WhatsApp.
Centro de Ayuda