Como configurar uma integração de API personalizada com o AI Assist
As instruções abaixo são apenas para computadores de mesa e notebooks.
O AI Assist do tawk.to permite conectar seu chat ao vivo a sistemas de back-end, oferecendo aos clientes acesso rápido a informações em tempo real sobre produtos e pedidos. Isso facilita para os clientes explorarem seu estoque, fazerem e acompanharem pedidos, agendarem compromissos e muito mais.
Prepare seu esquema OpenAPI
Primeiro, você vai precisar do seu esquema OpenAPI, que é um arquivo JSON (.json) ou YAML (.yaml) que define a comunicação entre a API e o AI Assist. Esse esquema inclui os modelos de dados da API, os endpoints, os parâmetros de solicitação e os formatos de resposta.
Hospede seu esquema OpenAPI
Em seguida, hospede o esquema OpenAPI em um servidor que permita acesso público. Você pode usar um repositório como o GitHub, armazenamento em nuvem como o Amazon S3 ou qualquer serviço de hospedagem web.
Integre com o AI Assist
Siga estas etapas para configurar sua integração:

3. Clique em Complementos (Add-ons) no menu superior.

4. Clique em Configurações (Settings) na seção do AI Assist.

5. Selecione o agente de IA.

6. Clique em “Integration/API”.

7. Clique em “Add Tool” na seção de API.

8. Insira a URL do arquivo de especificação OpenAPI no campo “Schema File URL”. Você pode obter essa URL do repositório ou serviço onde o arquivo está hospedado. Certifique-se de que a URL seja acessível publicamente e aponte corretamente para o arquivo de especificação.

9. Insira a URL base da API. Essa é a URL raiz da API. Você pode obtê-la com o fornecedor da API. Os endpoints, solicitações e respostas definidos no seu esquema OpenAPI serão acessados por meio dessa URL. Verifique se os endpoints especificados estão corretos para evitar erros.

10. Defina o método de autenticação apropriado para a API. Se a API não exigir autenticação, selecione “No Auth”.

Se escolher “Basic”, insira seu nome de usuário e senha.

10. Revise todas as informações e clique em “Save”.
Ajude o AI Assist a entender sua integração de API
O AI Assist usa suas fontes de dados, incluindo integrações de API, para responder aos clientes.Para ajudar o AI Assist a entender sua integração de API e responder com precisão, faça o seguinte:
- Garanta que o esquema da API tenha descrições detalhadas dos endpoints e dos parâmetros utilizados na integração.
- Atualize o “Base Prompt” na página de configurações para orientar o AI Assist sobre quando fazer uma solicitação à API e quais informações buscar. Por exemplo:
Coisas para lembrar
- Embora a URL base da API possa ser alterada, a URL do arquivo de esquema não pode ser editada. Se você atualizar o arquivo e receber uma nova URL, será necessário excluir a integração e adicioná-la novamente com a nova URL.
- Quando o AI Assist acessa informações por meio de uma solicitação de API, ele prioriza esses dados em relação a outras fontes e os utiliza para gerar respostas ao cliente. É possível personalizar essas respostas usando as instruções do Base Prompt, como definir o tom ou incluir botões clicáveis.
- Cada solicitação de API tem um ID exclusivo e representa um ponto de dados separado. As solicitações subsequentes são independentes das anteriores. Portanto, o AI Assist não considera interações anteriores ao fazer uma nova solicitação.
- Conversas muito longas podem ser cortadas, e o AI Assist pode não conseguir acessar informações mencionadas no início.
- Teste sua integração para verificar precisão, tempo de resposta e segurança. Siga as melhores práticas de autenticação e criptografia de dados.Otimize sua integração para garantir uma experiência de chat fluida. Crie uma experiência centrada no cliente que gere fidelização, aumente as vendas e impulsione seus negócios.
- Garanta que sua integração consiga lidar com o aumento no volume de chats à medida que o negócio cresce.
Confira estes guias com exemplos de integração do AI Assist com outras APIs:
Como integrar o AI Assist com o Shopify
Se você tiver sugestões sobre este artigo ou precisar de mais ajuda:
- Clique no ícone verde de chat ao vivo
- Agende uma chamada conosco
- Visite nossa comunidade
