Os agentes de IA fazem solicitações HTTP de servidor para servidor para o seu sistema de back-end. As solicitações são iniciadas quando um caminho do usuário inicia por gatilho um nó de integração em seu diálogo, e os dados mapeados retornados são armazenados e ficam disponíveis durante a sessão dos agentes de IA.
Requisitos técnicos da sua API de back-end
Tipos de APIs
Sua API deve seguir uma das seguintes arquiteturas:
- REST
- GraphQL
Resposta
A resposta da sua API deve seguir os requisitos gerais:
- Fornecer uma resposta da API em até 30 segundos.
- De preferência, retornar em formato JSON.
Autenticação
Do ponto de vista dos agentes de IA, a autenticação pode ser feita usando qualquer um dos seguintes métodos:
- Chave da API
- Token do portador
- Token de expiração
- Autenticação básica
- OAuth 2.0
- Listas de segurança/autorização de IPs
Lista de autoverificação
A lista de autoverificação abaixo contém perguntas e informações que ajudam a construir uma API robusta:
- A API é "pesquisável" com dados que um usuário típico conheceria, ou com dados provenientes do seu CRM?
- Os dados na resposta da API contêm informações que atendem ao seu caso de uso?
- Se o seu caso de uso exigir dados de diversos sistemas, você pode consolidá-los em uma camada intermediária?
- É possível saber quando a API retorna um código de status HTTP 200, 400 e 404?
- O que a API retorna se a entrada for inválida ou incorreta?
- Seu sistema define um limite de taxa da API?
- Quanto tempo seu sistema leva para enviar uma resposta?
Esteja preparado para fornecer:
• Documentação: Autenticação, consulta/corpo da solicitação de API e esquema de resposta
• (Opcionalmente, uma coleção do Postman.)
• Dados de teste para os resultados mais comuns.
Leia mais sobre o plano de integração no artigo anterior, Integração personalizada - preparação.