Autenticação | Desenvolvedores

Traduzido para sua conveniência. Código, nomes de campos e a referência da API continuam em inglês. Versão em inglês

Toda requisição à API é autenticada com um token de API. Um token age como o membro da equipe que é dono dele: vê e altera exatamente o que essa pessoa pode no espaço de agentes, limitado ainda pelo scope do token.

Criar um token

Abra Admin Center, Integrations, API tokens.
Escolha New token, dê um nome que diga o que o usa (por exemplo “Billing sync”) e escolha um scope.
Copie o token. Ele começa com desk_ e é mostrado só uma vez.

Scope	Permite
`read`	Somente requisições `GET`
`write`	Todos os métodos: `GET`, `POST`, `PUT`, `PATCH`, `DELETE`

Crie um token separado para cada integração, de um usuário de integração dedicado quando possível. Assim, revogá-lo afeta só essa integração.

Enviar o token

GET /api/tickets HTTP/1.1
Host: yourcompany.chaosdesk.io
Authorization: Bearer desk_xxxxxxxxxxxxxxxxxxxx
Accept: application/json

As respostas são JSON (application/json) ou JSON-LD (application/ld+json), conforme o cabeçalho Accept. Atualizações parciais usam PATCH com Content-Type: application/merge-patch+json.

Erros

Status	Significado
`401`	Token ausente, inválido, expirado ou revogado
`402`	O recurso não faz parte do seu plano (`plan_required`)
`403`	O dono do token não tem permissão, ou um token `read` tentou escrever
`422`	A validação falhou; o corpo lista os campos
`429`	Limite de taxa atingido, veja os limites de taxa

Os erros usam problem details RFC 9457 (application/problem+json).

API compatível com Zendesk

A API compatível com Zendesk aceita os mesmos tokens com os estilos de autenticação do Zendesk: Basic auth com {email}/token:{token}, bearer token ou credenciais de cliente OAuth.