Skip to main content
Esta seção documenta os 150 endpoints da v1, gerados a partir da especificação OpenAPI da API. Cada página mostra os parâmetros aceitos, o corpo da requisição, o formato da resposta e um playground para testar a chamada no próprio navegador.

​
URL base

Instalações on-premise usam o domínio do próprio ambiente, seguido de /api/v1.
Criar, editar, rotacionar e revogar tokens não faz parte da API. Por segurança, essas operações só podem ser feitas no painel.

​
Testando pelo playground

1

Abra qualquer endpoint

Comece por um GET, como GET /contacts. Leituras não alteram nenhum dado.
2

Informe o token

No campo Authorization, cole a sua chave sk_live_…. Ela fica guardada apenas no seu navegador.
3

Confira o servidor

O playground aponta para https://api.connectadesk.com/api/v1. Se a sua instalação for on-premise, troque pelo domínio do seu ambiente.
O playground faz chamadas reais. Um DELETE executado aqui apaga o registro de verdade, sem pedir confirmação e sem como desfazer. Enquanto estiver explorando, use dados de homologação.

​
O mapa dos módulos

Cada grupo do menu à esquerda corresponde a um módulo de permissão do token. Se um endpoint responder 403 ERR_API_FORBIDDEN_SCOPE, está faltando no seu token a permissão do módulo daquele grupo.

Conversas

Contatos, Atendimentos, Mensagens, Canais e Webchat. É a base para quem integra o atendimento.

Organização

Tags, Filas, Qualificações, Usuários e Perfis de permissões. Definem como os atendimentos são distribuídos e classificados, e o que cada pessoa pode fazer.

Iniciativas

Agendamentos, Respostas rápidas e Campanhas. Cobrem as mensagens que partem da empresa para o cliente.

Vendas

CRM, Produtos e Campos personalizados. Sustentam os painéis de vendas e o catálogo.

Relatórios

Relatórios de conversas, de automações e os indicadores do painel. Mostram os números da operação.

​
Convenções

Algumas regras valem para todos os endpoints:

Envelope

Todo recurso vem em data, e todo erro vem em error.

Paginação

page e perPage, com hasMore para saber se há mais páginas. Não há total.

Idempotência

Idempotency-Key em POST e PUT.

Limites

Limite de requisições por minuto, por empresa.

​
Versionamento

A versão faz parte do caminho: /api/v1. Enquanto ela existir, as mudanças serão apenas aditivas. Podem surgir campos e endpoints novos, mas os que já existem mantêm nome, tipo e significado. Por isso, a sua integração deve ignorar os campos que não conhece, em vez de falhar ao encontrá-los. Mudanças que quebram a compatibilidade só chegam com uma nova versão no caminho.