Pular para o conteúdo principal

Chamada de API

Configure integrações personalizadas para que o chatbot possa procurar ou enviar informações em tempo real (ex: consultar estado de encomenda, procurar produtos, registar tickets).

Pode adicionar múltiplos endpoints, respeitando o limite de ações ativas do seu plano.

Detalhes do Endpoint​

Defina a identidade base do seu pedido:

  • Nome do endpoint: Um nome descritivo (Ex: Procurar cliente por e-mail).
  • Método: GET, POST, PUT, DELETE, etc.
  • URL: O endereço do recurso na API externa.

Autenticação​

Se a sua API exigir segurança, clique no botão Autenticação para abrir o modal de configuração:

  • Método e URL de Autenticação: Define onde o WiseMind deve procurar o token.
  • Body e Headers: Envie as credenciais necessárias (ex: username e password em formato JSON).
  • Caminho do token na resposta: Notação por pontos para extrair o token (ex: data.access_token).
  • Expira em (s): Tempo de vida do token para que o WiseMind saiba quando o renovar.

Instruções de Utilização e Pós-execução​

Oriente o WiseMind sobre o comportamento da integração:

  • Quando deve esta ação ser utilizada?

    Explique o cenário ideal. Ex: "Use esta ação quando o cliente quiser consultar o estado de uma encomenda. Peça o CPF antes de chamar a API."

  • Instruções pós-execução

    Indique como o assistente deve tratar a resposta. Ex: "Resuma a resposta da API em formato de lista amigável e pergunte se o cliente precisa de mais alguma coisa."

Dados Adicionais​

Adicione campos opcionais enviados no pedido quando necessário. O painel está dividido em separadores:

  • Headers, Body, Path Params, Querystring
  • Pode adicionar múltiplos itens definindo a Chave e o Valor em cada separador.

Dados do utilizador identificado​

Se o seu site utiliza Identificação de Utilizadores, os claims verificados do JWT ficam disponíveis em qualquer campo do pedido (URL, Headers, Body, Path Params, Querystring) através da sintaxe {{identity.<claim>}}.

Exemplos:

GET https://api.seusite.com/customers/{{identity.account_id}}/orders
Authorization: Bearer {{identity.api_token}}

Os valores só são interpolados após a verificação da assinatura do token. Se o token estiver ausente, expirado ou inválido, a ação não é executada.

Testar Endpoint

Antes de guardar, pode expandir a secção Testar Endpoint para simular um pedido real com valores de exemplo e garantir que a configuração está correta.