Suporte ao cliente

Conecte-se à API do initdesk em 15 minutos

A API do initdesk está no ar — emita um token, encontre o ID da sua organização e liste tickets com curl em uma sessão.

A API do initdesk está disponível hoje em developers.initdesk.com, com requisições enviadas para https://api.initdesk.com.
Se você não tem certeza se precisa da API, webhooks ou BYOD, leia API, webhooks ou BYOD primeiro — este post assume que você quer seu código chamando o initdesk (criar ou ler tickets, solicitantes, mensagens ou conteúdo da Central de Ajuda).
Abaixo está o caminho mínimo para uma chamada funcionando: token, ID da organização, um curl, depois a especificação OpenAPI para todo o resto.

O que você precisa antes de começar

  • Uma conta initdesk onde você é Proprietário da conta ou Admin (apenas esses papéis podem emitir tokens de API).
  • O ID numérico da organização em Settings → General. Caminhos da API usam esse número — não o public_id em string da organização das URLs do produto.
  • Um lugar para armazenar o token com segurança. O initdesk armazena um hash no servidor; você vê o token bruto apenas uma vez na criação.

Emita um token de organização

  1. Abra Settings → API access.
  2. Gere um novo token de integração com escopo de organização.
  3. Copie o token imediatamente para seu gerenciador de segredos ou cofre de senhas.
Envie-o em cada requisição com o header personalizado:
X-Initdesk-Token: YOUR_TOKEN_HERE
Esse token só pode acessar recursos da organização para a qual foi emitido. Chamadas para URLs de outra organização retornam 403 Forbidden. Tokens inválidos ou revogados retornam 401 ou 403 conforme o caso. Revogue tokens comprometidos na mesma tela de configurações.

Sua primeira requisição: confirme a organização

Substitua ORG_ID e YOUR_TOKEN nos exemplos abaixo.
curl -sS \
  -H "X-Initdesk-Token: YOUR_TOKEN" \
  "https://api.initdesk.com/organizations/ORG_ID/"
Uma resposta bem-sucedida confirma que você está no tenant certo e mostra configuração da organização que pode afetar o comportamento de tickets (por exemplo se a marcação automática está habilitada). Se receber 401 ou 403, verifique novamente o token e se ORG_ID corresponde a Settings → General.

Liste caixas de entrada (necessário antes de criar tickets)

Tickets são criados em uma caixa de entrada específica. Liste-as para copiar um id de caixa de entrada para chamadas POST posteriores:
curl -sS \
  -H "X-Initdesk-Token: YOUR_TOKEN" \
  "https://api.initdesk.com/organizations/ORG_ID/inboxes/"
Endpoints de listagem retornam JSON paginado: count, next, previous e results (tamanho de página padrão 20). Siga URLs next até ter o que precisa.

Liste tickets (caminho de leitura)

curl -sS \
  -H "X-Initdesk-Token: YOUR_TOKEN" \
  "https://api.initdesk.com/organizations/ORG_ID/tickets/"
Por padrão, tickets de spam são excluídos. Para trabalhar com spam, passe is_spam=true. Filtre por solicitante com customer_id quando souber o id de API do cliente.
Para busca e filtros predefinidos, use o endpoint de busca de tickets documentado no índice de referência da API — útil para dashboards operacionais sem exportar toda a caixa de entrada.

id vs public_id do ticket (e onde ficam as mensagens)

Cada ticket tem dois identificadores:
CampoUso
idChave primária em URLs da API (/tickets/{id}/, /tickets/{id}/messages/)
public_idNúmero visível ao usuário em assuntos de e-mail e na interface ("Ticket #1234")
Sempre use id em chamadas de API. Mostre public_id aos clientes quando precisar do rótulo familiar.
A linha do ticket é o container (assunto, status, responsável, caixa de entrada, tags). A conversa — respostas, notas internas, eventos do sistema — está em mensagens:
/organizations/{organization_id}/tickets/{ticket_id}/messages/
Recupere um ticket para metadados; liste mensagens quando precisar da conversa completa. Comportamento em nível de campo está em Entities and relationships.

OpenAPI, paginação e limites de taxa

  • Esquema OpenAPI: https://api.initdesk.com/schema.yaml — gere clientes ou explore cada caminho em /organizations/{organization_id}/.
  • Paginação: listas por número de página com count, next, previous, results.
  • Limites de taxa: 60 requisições por minuto por token para a maioria dos endpoints. Criação de tickets também é limitada por organização em base horária. Em 429 Too Many Requests, faça backoff com atraso exponencial e tente novamente.
Criar tickets, responder, sincronizar artigos da Central de Ajuda e gerenciar clientes estão todos documentados na referência para desenvolvedores — este post para em leitura/listagem para você verificar autenticação antes de escrever dados.
Dúvidas sobre endpoints beta ou acesso: support@initdesk.com.
--
O initdesk é um help desk com IA para equipes pequenas. A API foi lançada hoje junto com developers.initdesk.com. Mais em Atualizações do produto e X @initdeskhq.