# Connecta DESK

> Documentação da API pública do Connecta DESK.

- [Referência da API (150 pages)](https://docs.connectadesk.com/_llms/pt-br/referencia-da-api.txt): Documentation for Referência da API.

## Documentação

### Comece aqui

- [API do Connecta DESK](https://docs.connectadesk.com/introduction.md): API REST para automatizar atendimento, CRM, campanhas e cadastros do Connecta DESK. Um token por empresa, com permissão por módulo e método.
- [Primeira chamada](https://docs.connectadesk.com/quickstart.md): Crie um token no painel do Connecta DESK e faça sua primeira requisição autenticada à API v1.
- [Autenticação](https://docs.connectadesk.com/authentication.md): Como funciona o token da API do Connecta DESK: formato sk_live_, header Bearer, prazo de validade, IPs autorizados e rotação.

### Fundamentos

- [Permissões do token](https://docs.connectadesk.com/essentials/permissoes.md): O token é autorizado por módulo e por método. Conheça os 17 módulos da API do Connecta DESK e como definir o escopo mínimo de cada integração.
- [Requisições e respostas](https://docs.connectadesk.com/essentials/requisicoes-e-respostas.md): O envelope de resposta da API do Connecta DESK: data, meta e error. Formatos aceitos, códigos de status e a ordem de verificação de cada requisição.
- [Paginação](https://docs.connectadesk.com/essentials/paginacao.md): Como paginar listas na API do Connecta DESK com page e perPage, e como usar hasMore para saber se há mais páginas.
- [Idempotência](https://docs.connectadesk.com/essentials/idempotencia.md): Use o header Idempotency-Key para repetir POST e PUT na API do Connecta DESK sem executar a mesma operação duas vezes.
- [Limites de uso](https://docs.connectadesk.com/essentials/limites-de-uso.md): Limite de requisições por empresa na API do Connecta DESK: headers RateLimit, resposta 429 e o que fazer ao atingir o limite.
- [Erros](https://docs.connectadesk.com/essentials/erros.md): Formato das respostas de erro da API do Connecta DESK, tabela de códigos ERR_ e como tratar cada tipo de falha na sua integração.

### Guias

- [Construindo uma integração](https://docs.connectadesk.com/guides/primeira-integracao.md): Um exemplo completo com a API do Connecta DESK, do pedido no e-commerce ao contato cadastrado, à mensagem enviada e ao card no painel do CRM.
- [Enviar mensagens](https://docs.connectadesk.com/guides/enviar-mensagens.md): Como enviar mensagens pela API do Connecta DESK: os quatro tipos de mensagem, a resposta 202 com jobId e a consulta do resultado.
- [Webchat](https://docs.connectadesk.com/guides/webchat.md): Como usar o webchat do Connecta DESK pela API: enviar mensagens para visitantes, incluindo mensagens interativas, e conversar como visitante a partir do seu próprio sistema.
- [Segurança do token](https://docs.connectadesk.com/guides/seguranca-do-token.md): Boas práticas para os tokens da API do Connecta DESK: permissões mínimas, prazo de validade, lista de IPs permitidos, rotação e o que fazer se um token vazar.

## OpenAPI Specs

- [openapi](/api-reference/openapi.yaml)

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [Brazilian Portuguese / Referência da API (150 pages)](https://docs.connectadesk.com/_llms/pt-br/referencia-da-api.txt): Documentation for Brazilian Portuguese / Referência da API.
- [English (163 pages)](https://docs.connectadesk.com/_llms/en.txt): Documentation for English.
- [English / API Reference (150 pages)](https://docs.connectadesk.com/_llms/en/api-reference.txt): Documentation for English / API Reference.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.