> For the complete documentation index, see [llms.txt](https://botconversa.gitbook.io/bem-vindo-ao-botconversa/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://botconversa.gitbook.io/bem-vindo-ao-botconversa/integracoes/api-botconversa/documentacao-api-botconversa.md).

# Documentação API BotConversa

Este artigo foi preparado para você que deseja aprender como utilizar a API do botconversa, aproveite ao máximo tudo que está presente nesse artigo e não deixe de ver o vídeo abaixo:

{% embed url="<https://youtu.be/8c0RRJ81cPY>" %}

## ❓ Como acessar a documentação API do BotConversa?

{% embed url="<https://backend.botconversa.com.br/swagger>" %}
**Clique** acima para ser redirecionado para a DOCUMENTAÇÃO API DO BOTCONVERSA
{% endembed %}

### Copie a chave de integração API do BotConversa:

* Acesse sua companhia do botconversa, vá em configurações > integrações e copie a chave: **Webhook Integration**

<figure><img src="https://381698884-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKN5jVER9WQHLGiLeuhi9%2Fuploads%2FwfQ0I89m3CTz14WWFtQW%2Fimage.png?alt=media&amp;token=4cb7f759-0892-4085-bb69-22ef011dc817" alt=""><figcaption><p>Copie a chave: WEBHOOK INTEGRATION</p></figcaption></figure>

### Acesse a nossa documentação e Faça Testes de Requisições:

Ao acessar nossa documentação, clique no botão localizado no canto direito da página: **AUTHORIZE** e insira a **chave API** que copiou em sua companhia conforme descrito acima.

&#x20;      ![](https://381698884-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKN5jVER9WQHLGiLeuhi9%2Fuploads%2Ff91a1dc9nLTBlxxKR1ad%2Fimage.png?alt=media\&token=cbddad42-ba55-43ca-a809-2b70f8b6afd4)      **➡️**      ![](https://381698884-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKN5jVER9WQHLGiLeuhi9%2Fuploads%2Fm6tv3hH1xJT2lN3ay9at%2Fimage.png?alt=media\&token=3187fc6b-eafd-48fc-8414-a971f6731f37)

Após cadastrado a CHAVE API, você está pronto para realizar seus testes de requisições direto pela nossa documentação. Basta clicar no endpoint que deseja testar e então clicar em "TRY IT OUT" como mostra na imagem abaixo:

<figure><img src="https://381698884-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FKN5jVER9WQHLGiLeuhi9%2Fuploads%2FQepsjaHmKTjc3gXNKMmP%2Fimage.png?alt=media&amp;token=d976265d-31c1-4024-a2ba-aa8c9fe3017f" alt=""><figcaption></figcaption></figure>

## **❓ O que é possível fazer utilizando os Endpoints do BotConversa?**

Basicamente, os endpoints possuem funcionalidades específicas e muito usadas no BotConversa, com a diferença de poder ser realizada através de um software externo, como:

* Adicionar Contatos na Audiência&#x20;
* Deletar um contato de uma companhia
* Adicionar Etiquetas em Contatos
* Adicionar Campos Personalizados em Usuários
* Enviar uma Mensagem para um Usuário&#x20;
* Enviar um Fluxo para um usuário
* Cadastrar o Usuário em uma Sequência&#x20;
* Cadastrar o Usuário em uma Campanha
* Atribuir um Contato para um Atendente
* Definir Valores aos Campos do Robô&#x20;

{% hint style="warning" %}
Estude com atenção as APIs e não deixe de ver o vídeo no início desse artigo.\
\
Caso queira ver tutoriais prontos e explicados por nós, utilize a barra lateral para navegar pelos tutoriais de [Softwares.](/bem-vindo-ao-botconversa/integracoes/ferramentas-online.md)
{% endhint %}