API
API Interaflow para dados e agentes externos
Comece pela autenticação e escolha entre dados para BI e automação de conversas.
Atualizado em
Escolha o caminho da sua integração
O Interaflow oferece contratos distintos para consultar dados de atendimento e para conectar um agente externo à conversa. Comece pelo caso de uso e use a origem HTTPS do ambiente da sua organização.
| Necessidade | Caminho | Documentação |
|---|---|---|
| Levar dados de URA, chamadas, gravações e cadastros para BI ou outro sistema | API de Integração, base /api/v1/integracao/v1 | Referência de endpoints |
| Conectar um chatbot ao atendimento por mensagens e transferir para humano | Webhook do nó Controle Externo e callback | Agentes externos |
| Criar credenciais e definir permissões | Chaves de API da organização | Autenticação e escopos |
| Usar telefonia e registrar chamadas no Salesforce | Softphone no Lightning e conexão com o endpoint da org | Integração Salesforce |
Antes de implementar
- Confirme com o administrador o endereço HTTPS e a versão instalada no ambiente.
- Crie uma chave por consumidor e conceda os escopos necessários ao contrato escolhido.
- Guarde a chave no servidor ou gerenciador de segredos da integração.
- Teste uma consulta ou um turno de conversa em homologação.
- Trate erros, limites e registros ainda em processamento antes de ampliar o uso.
Autenticação depende do endpoint
A API de Integração aceita a chave ik_... diretamente e verifica escopos por rota. O callback de agentes externos também aceita chave diretamente. Já endpoints internos da aplicação que exigem um usuário precisam de JWT e das permissões desse usuário. Não suponha que uma chave possa acessar qualquer rota do painel.
Veja os exemplos e o caso de troca de chave vinculada a usuário por JWT no guia de autenticação.