Passar para o conteúdo principal

Como funciona a API da Clint

Neste artigo, explicamos como funciona a API da Clint e o que não está incluso na documentação.

Tempo de Leitura: 3min. 

A API da Clint está organizada em 8 grupos principais de endpoints (pontos de acesso a funcionalidades específicas de uma API): contatos, negócios, grupos, status de perda, origens, tags, usuários e campos personalizados da conta. Para utilizar qualquer um desses recursos, é necessário autenticar a requisição utilizando um API Token, que deve ser enviado nos cabeçalhos das requisições.

Clique aqui e acesse a documentação da nossa API.

⚠️ Atenção: Somente os clientes do plano Elite possuem acesso à chave da API Clint.

Como ter acesso à chave da API através da Clint?

Para ter acesso a chave da API da Clint é só clicar em "Conta" no canto superior direito da plataforma.

Em seguida, clique em "API" na coluna à esquerda e depois em "Copiar" para copiar o seu token de acesso à API e utilizar no header de suas requisições.

Quais funcionalidades não estão disponíveis na API Pública?

Atualmente, a API pública da Clint não oferece suporte para o módulo de atividades.
Não é possível criar, atualizar, concluir ou excluir atividades via API. Essas ações devem ser feitas diretamente pela interface do sistema.

Atendimento (Mensagens por WhatsApp) - Beta

Os endpoints relacionados ao módulo de atendimento estão atualmente em fase Beta e, funcionam exclusivamente para conexões via API Oficial.

  • A API de mensagens suporta envio de vídeo por URL e áudio como nota de voz (PTT)

  • Os endpoints de Chats e Messages contam com filtros por last_message_at, last_response_at e created_at, além do campo updated_at para facilitar a extração de histórico

  • Há também um endpoint para registrar anotações internas em uma conversa, permitindo integração direta com agentes de IA externos

Respondeu à sua pergunta?