API da ORYKSA, webhooks e portal developer
Conecte apps e sistemas ao seu colaborador de IA com chaves de API e webhooks.
A API da ORYKSA permite que desenvolvedores usem seu colaborador de IA em seus apps, sites e sistemas: enviar mensagens de clientes e receber respostas, manter o conhecimento (Brain) sincronizado, informar conversões e receber webhooks quando a IA responde ou marca um agendamento.
Por onde começar: documentação completa em inglês, português e espanhol em developer.oryksa.com, com arquivo OpenAPI, coleção Postman e console "Try it".
Criar uma chave de API
- Entre em developer.oryksa.com com sua conta ORYKSA e abra Keys.
- Digite um nome (por exemplo "app iOS") e clique em Create key.
- Copie a chave na hora. Por segurança ela é mostrada uma única vez.
Revogue uma chave a qualquer momento: os apps que a usam param de funcionar na hora. Guarde as chaves em um servidor, nunca dentro de um site ou de um app.
Webhooks
No mesmo lugar adicione o endereço (https) que deve receber os eventos e escolha os eventos: mensagem respondida, agendamento criado, limite do plano atingido, conhecimento atualizado. Guarde o segredo de assinatura mostrado uma vez e use Test para verificar a entrega.
Conversões
Seu site ou app pode avisar a ORYKSA quando uma conversa deu resultado com POST /v1/conversions (venda, lead, cadastro ou agendamento). Você recebe um alerta, e a ORYKSA pode responder sobre isso no chat do painel.
Planos
A API é um canal web, como o chat do site. Cada resposta da IA conta como uma interação do plano, com os mesmos limites do WhatsApp.
Central de Ajuda