Contato
Português

Registro de mudanças da API

Mudanças na API REST do ChaosDesk, na API compatível com Zendesk e nas bibliotecas cliente oficiais, as mais recentes primeiro.

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

Ampliamos a API sem quebrá-la: novos endpoints, novos parâmetros opcionais e novos campos de resposta podem aparecer a qualquer momento, então ignore campos que você não conhece. Nada é removido nem muda de tipo no lugar. Tudo o que quebraria uma integração é anunciado aqui com pelo menos 12 meses de antecedência, com cabeçalhos Deprecation e Sunset nas operações afetadas e um e-mail aos donos dos espaços de trabalho, e o formato antigo continua funcionando durante todo esse período. As regras completas estão em versionamento e descontinuação da API.

As entradas são agrupadas em Adicionado, Alterado, Descontinuado e Removido. Nada foi descontinuado nem removido até agora.

2026-11-06

Adicionado

  • Bibliotecas cliente oficiais para PHP (chaosdesk/chaosdesk-php), Node.js (@chaosdesk/api) e Python (chaosdesk), geradas a partir do documento OpenAPI, e uma coleção do Postman. Veja as bibliotecas cliente.
  • API de perfis e eventos na API compatível com Zendesk, no formato do Zendesk: PUT /zd/api/v2/user_profiles?identifier=, GET /zd/api/v2/users/{user_id}/profiles, POST /zd/api/v2/user_profiles/events, GET /zd/api/v2/users/{user_id}/events e mais. Perfis de vários sistemas são ligados a um único cliente por e-mail, telefone ou id externo.
  • Marketplace de apps: desenvolvedores enviam para revisão apps feitos no framework de apps; administradores instalam apps revisados com um clique.
  • Configuração como código: GET e POST /zd/api/v2/chaosdesk/config.yaml baixam e enviam campos, formulários, regras, SLAs e visualizações de uma conta em YAML, com simulação.
  • API compatível com Zendesk: atualizar, show_many e excluir usuários; criar, atualizar, excluir e buscar organizações; avaliações de satisfação; macros com aplicar; visualizações com executar e contagens; exportação de busca.

1.0.0

  • Primeira versão pública da API REST (/api), documentada na referência da API, e da API compatível com Zendesk (/zd/api/v2).