O Agentes de IA - Avançado faz solicitações HTTP de servidor para servidor para seu sistema de back-end. As solicitações são iniciadas quando um caminho de usuário aciona um nó de integração em seu diálogo, e os dados retornados mapeados são armazenados e ficam disponíveis durante a sessão do Agentes de IA - Avançado.
Requisitos técnicos de sua API de back-end
Tipos de API
Sua API deve seguir uma das arquiteturas a seguir:
- REST
- GraphQL
Resposta
Sua resposta da API deve seguir os requisitos gerais:
- Fornecer uma resposta da API em até 30 segundos.
- De preferência, retornar em formato JSON.
Autenticação
A partir da perspectiva do Agentes de IA - Avançado, é possível autenticar usando um dos métodos a seguir:
- Chave da API
- Token do portador
- Token de validade
- Autenticação básica
- OAuth 2.0
- Listas seguras de IP/lista de autorização
Lista de autoverificação
A lista de autoverificação abaixo contém perguntas e informações que ajudarão você a criar uma API robusta:
- A API é "pesquisável" com dados que um usuário comum conheceria ou com dados transmitidos do seu CRM?
- Os dados na resposta da API contêm informações que atendem ao seu caso de uso?
- Se seu caso de uso requer dados de vários sistemas, é possível consolidá-los em uma camada intermediária?
- É possível saber quando a API gera 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?
Prepare-se para fornecer:
• Documentação: autenticação, consulta da solicitação da API/esquema de corpo e resposta.
• (Opcionalmente, uma coleção do Postman.)
• Dados do teste para os resultados mais comuns.
Saiba mais sobre o plano de integração no artigo anterior Integração personalizada - preparação.