🌐API

Suri recebe e responde a chamados de serviços externos

Através de nossa API, é possível solicitar dados e realizar ações importantes na Suri.

URL da API

A URL base de acesso à API é o endpoint do chatbot, que pode ser encontrado na página de Configurações do Portal, seguido de /api.

Exemplo de URL base de chamada da API:

https://xxx.azurewebsites.net/api

Autenticacão

A autenticação da API se dá através de Bearer token, cujo token também pode ser encontrado na tela de Configurações, logo acima do campo endpoint.

Adicione o seguinte item ao header de sua requisicão, substituindo XXX pelo seu token:

Authorization: Bearer XXXX

Cada endpoint é único por chatbot, portanto, é um ambiente seguro e que deve apresentar baixa latência. É importante certificar-se de armazenar token de acesso e endpoint de forma segura em sua aplicação.

Utilizacão

Como toda API, é a forma ativa de realizar ações na Suri, diferente dos webhooks, que representam uma forma passiva (onde seu serviço recebe eventos). Acessando nossa documentação é possível encontrar todas as possibilidades, mas podemos citar algumas das mais utilizadas:

• Importar contato: importa novo contato do canal WhatsApp para o chatbot e Portal de atendimento, podendo preencher e-mail, observações, documento de identificação, etc.
• Listar contatos: lista todos os contatos do chatbot em questão, trazendo todos os dados.
• Enviar mensagem: envia nova mensagem para o contato identificado pelo ID informado. Podendo ser mensagem de texto, mídia ou template de WhatsApp.
• Listar mensagens de contato: lista mensagens trocadas com contato, contendo mensagens de chatbot e agente humano.