ORYKSA AI Centro de Ajuda

API da ORYKSA, webhooks e portal developer

Liga apps e sistemas ao teu colaborador de IA com chaves de API e webhooks.

A API da ORYKSA permite a programadores usar o teu colaborador de IA nas suas apps, sites e sistemas: enviar mensagens de clientes e receber respostas, manter o conhecimento (Brain) sincronizado, reportar 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 ficheiro OpenAPI, coleção Postman e consola "Try it".

Criar uma chave de API

  1. Entra em developer.oryksa.com com a tua conta ORYKSA e abre Keys.
  2. Escreve um nome (por exemplo "app iOS") e carrega em Create key.
  3. Copia a chave logo. Por segurança só é mostrada uma vez.

Revoga uma chave a qualquer momento: as apps que a usam deixam de funcionar de imediato. Guarda as chaves num servidor, nunca dentro de um site ou de uma app.

Webhooks

No mesmo sítio adiciona o endereço (https) que deve receber os eventos e escolhe os eventos: mensagem respondida, agendamento criado, limite do plano atingido, conhecimento atualizado. Guarda o segredo de assinatura mostrado uma vez e usa Test para verificar a entrega.

Conversões

O teu site ou app pode avisar a ORYKSA quando uma conversa deu resultado com POST /v1/conversions (venda, lead, registo ou agendamento). Recebes um alerta, e a ORYKSA pode responder-te 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.

Este artigo foi útil?
Obrigado pelo feedback.
Avalie este artigo
★ ★ ★ ★ ★
Sê o primeiro a avaliar.

Não encontraste o que precisas?

Abre um ticket de suporte e respondemos rapidamente.

Abrir ticket