Skip to main content
Bem-vindo à documentação das APIs do Clickdesk. Seja você construindo fluxos de trabalho personalizados para sua equipe de suporte, integrando o Clickdesk ao seu produto, ou gerenciando usuários em instalações, nossas APIs fornecem a flexibilidade e poder para ajudá-lo a fazer mais com o Clickdesk. O Clickdesk oferece três categorias de APIs, cada uma projetada com um caso de uso específico em mente:
  • APIs de Aplicação – Para automação em nível de conta e integrações voltadas para agentes.
  • APIs de Cliente – Para construir interfaces de chat personalizadas para usuários finais
  • APIs de Plataforma – Para gerenciar e administrar instalações em escala

​
APIs de Aplicação

As APIs de Aplicação são projetadas para interagir com uma conta do Clickdesk a partir da perspectiva de um agente/administrador. Use-as para construir ferramentas internas, automatizar fluxos de trabalho ou realizar operações em massa como importação/exportação de dados.
  • Autenticação: Requer um access_token de usuário, que pode ser gerado nas Configurações do Perfil após fazer login em sua conta do Clickdesk.

​
APIs de Cliente

As APIs de Cliente são destinadas a construir experiências de mensagens personalizadas sobre o Clickdesk. Se você não está usando o widget nativo do site ou quer incorporar chat em seu aplicativo móvel, essas APIs são o caminho a seguir.
  • Autenticação: Usa inbox_identifier (das Configurações → Configuração em caixas de entrada da API) e contact_identifier (retornado ao criar um contato).

​
APIs de Plataforma

As APIs de Plataforma são usadas para gerenciar instalações do Clickdesk no nível administrativo. Essas APIs permitem controlar usuários, funções e contas, ou sincronizar dados de sistemas de autenticação externos.
Nota: As APIs de Plataforma não podem acessar contas ou usuários criados via interface do Clickdesk, ou por outras chaves de API. Elas só podem acessar contas, usuários e outros objetos criados pela chave de API de plataforma específica usada para autenticação, ou objetos explicitamente permitidos para essa chave de API.
  • Autenticação: Requer um access_token gerado por um App de Plataforma, que pode ser criado no Console Super Admin.
Use a API certa para seu caso de uso, e você poderá estender, personalizar e integrar o Clickdesk em sua stack com facilidade.

​
FAQ

​
Por que recebo um erro 401 ‘Recurso não permitido’ ao usar tokens da API de Plataforma?

As APIs de Plataforma não podem acessar contas ou usuários criados via interface do Clickdesk, ou por outras chaves de API. Elas só podem acessar contas, usuários e outros objetos criados pela mesma chave de API, ou objetos explicitamente permitidos para essa chave de API. Se você precisar conceder acesso a um App de Plataforma para um objeto (como uma Conta) que ele não criou, você pode adicionar manualmente a permissão usando o seguinte comando em um console Rails (substitua os números pelos IDs corretos): 
PlatformAppPermissible.create!(platform_app: PlatformApp.find(1), permissible: Account.find(1))

​
O que devo fazer se a documentação da API parecer desatualizada?

Se você encontrar discrepâncias entre a documentação da API e o comportamento real da API, recomendamos inspecionar as requisições reais feitas pela interface do Clickdesk através da aba Network do console de desenvolvedor do seu navegador para ver o formato exato da requisição e estrutura de payload que funciona com a API atual, então replicar a mesma estrutura de requisição em sua integração.