REST API fornece 200 respostas, mas a solicitação não funcionou

Sintomas do problema

Ao fazer uma solicitação usando a API, vejo um código de resposta de 200, mas a alteração que eu solicitei foi ignorada. Por que isso estava acontecendo?

Etapas de resolução

A REST API do Zendesk foi desenvolvida para ser, de certa forma, permissiva. Portanto, ele ignorará os atributos que não existem no nosso modelo e tentará continuar processando o restante da solicitação.

Um exemplo seria tentar enviar a seguinte carga para atualizar um ticket com um atributo que não é parte do objeto do ticket, como esta carga:

{ "ticket": { "non_existent_field": "42" } }

Anon_existent_field será ignorado e nada mais na carga causará o erro.

Obs.: O cabeçalho estava disponível anteriormente, mas não é retornado no momento. Estamos analisando os motivos para isso.

Para verificar se algum campo é ignorado, aguarde a presença de um atributo X-Zendesk-Api-Warn cabeçalho. O exemplo acima mostrará isso nos cabeçalhos de resposta:

X-Zendesk-Api-Warn: Removed restricted keys ["ticket.non_existent_field"] from parameters according to allowlist 

Prática recomendada da REST API

Compare os valores enviados na carga com o objeto de resposta sempre que possível. Além de detectar o erro acima, isso também informará se algo mais nas regras de negócios está modificando os valores que você está tentando definir.

Aviso sobre a tradução: este artigo foi traduzido por um software de tradução automática para oferecer a você uma compreensão básica do conteúdo. Medidas razoáveis foram tomadas para fornecer uma tradução precisa, no entanto, a Zendesk não garante a precisão da tradução.

Em caso de dúvidas relacionadas à precisão das informações contidas no artigo traduzido, consulte a versão oficial do artigo em inglês.