> For the complete documentation index, see [llms.txt](https://sejasuri.gitbook.io/manual-de-integracao/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sejasuri.gitbook.io/manual-de-integracao/api.md).

# API

Suri Shop by Totvs 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 Shop by Totvs.

### URL da API

A URL base de acesso à API é o e*ndpoint* do chatbot, que pode ser encontrado na página de Configurações do [Portal](https://portal.chatbotmaker.io/), seguido de `/api`.

{% hint style="success" %}
Exemplo de URL base de chamada da API:

`https://xxx.azurewebsites.net/api`
{% endhint %}

<figure><img src="https://1837340083-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5E34bepJuSf1ssBFTTtX%2Fuploads%2FSn7l2PTXnhU1YxS76wwA%2FPortal-Config-2.png?alt=media&amp;token=c19adf60-2964-4b01-ba3d-a15555cf993d" alt=""><figcaption></figcaption></figure>

### Autenticacão

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

{% hint style="success" %}
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.
{% endhint %}

### Utilizacão

Como toda API, é a forma ativa de realizar ações na Suri Shop by Totvs, diferente dos *webhooks*, que representam uma forma passiva (onde seu serviço recebe eventos). Acessando nossa [documentação](https://documenter.getpostman.com/view/17684221/UUxz9mt5#b620644f-3971-4e54-97f3-5f581b67df79) é possível encontrar todas as possibilidades, mas podemos citar algumas das mais utilizadas:

* [Importar contato](https://documenter.getpostman.com/view/17684221/UUxz9mt5#e5e66ac6-d9bd-4138-8fd3-02d057c4d65d): 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](https://documenter.getpostman.com/view/17684221/UUxz9mt5#e5e66ac6-d9bd-4138-8fd3-02d057c4d65d): lista todos os contatos do chatbot em questão, trazendo todos os dados.
* [Enviar mensagem](https://documenter.getpostman.com/view/17684221/UUxz9mt5#31654c0c-ccd2-4252-871d-ef2180ab6ed7): 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](https://documenter.getpostman.com/view/17684221/UUxz9mt5#31654c0c-ccd2-4252-871d-ef2180ab6ed7): lista mensagens trocadas com contato, contendo mensagens de chatbot e agente humano.