Resolver erros comuns da API REST
Ao trabalhar com a API do Wrike, é inevitável encontrar erros. Eles podem ocorrer por diversos motivos, como direitos de usuário insuficientes, limitações de licença da conta ou formatação incorreta. Neste artigo, vamos abordar alguns dos erros de API mais comuns e fornecer etapas de solução de problemas para ajudá-lo a identificar e corrigir esses problemas rapidamente.
Importante
Sempre confira novamente a documentação da API.
O exemplo a seguir representa uma resposta de erro comum resultante de uma solicitação de API malsucedida.
Código de status: XXX
Corpo da resposta:
{
"errorDescription": "descrição legível por humanos do erro.",
"error": "código curto, padronizado ou identificador para o erro específico que ocorreu"
}
Códigos de Status
Causa possível
URL base incorreta.
Etapas de solução de problemas
Verifique se sua URL base está correta.
O Wrike armazena os dados dos clientes em vários data centers localizados nos EUA e na União Europeia. Para acessar seus dados, use a URL base apropriada para a localização dos dados. Você pode determinar sua URL base observando a URL na barra de endereços ao acessar sua conta Wrike em um navegador.
Causa possível
- O tipo HTTP de solicitação é inválido, os dados críticos da solicitação estão ausentes ou incompletos (por exemplo, nenhum corpo de anexo).
- O cabeçalho está ausente.
- O nome do parâmetro da solicitação é inválido.
- O parâmetro da solicitação não é suportado para este endpoint.
Exemplo: Um usuário tenta usar o parâmetro 'firstName' em uma chamada GET/contacts chamada
Etapas de solução de problemas
- Verifique a documentação da API para garantir que sua solicitação esteja formatada corretamente: todos os parâmetros devem ser válidos e suportados pelo endpoint.
- Certifique-se de que todos os cabeçalhos necessários estão incluídos na solicitação.
Causa possível
- O parâmetro obrigatório está ausente.
- O valor do parâmetro está preenchido ou formatado incorretamente.
Etapas de solução de problemas
- Verifique a documentação novamente e certifique-se de que todos os parâmetros marcados como obrigatórios estão presentes na sua chamada.
- Garanta que o valor do parâmetro esteja correto e formatado de acordo com a documentação.
Causa possível
Um método de API incorreto foi utilizado.
Exemplo: Um usuário tenta enviar uma chamada PUT/tasks que não é suportada.
Etapas de solução de problemas
Certifique-se de que o método usado é suportado para o endpoint e está definido corretamente.
Causa possível
A ação solicitada não é permitida devido a limitações de licença/quota, etc.
- O usuário não tem as permissões necessárias para executar a ação solicitada.
Exemplo: Um usuário com uma assinatura Business Plus chama o método GET/data_export.
-
A conta não possui a licença necessária para executar a operação.
Exemplo: Um Colaborador tenta atualizar o título de uma Pasta. -
A operação não pode ser executada.
Exemplo: Um usuário tentou criar uma dependência que já existe.
Etapas de solução de problemas
- Revise as permissões do usuário nas configurações da conta Wrike. Certifique-se de que o usuário tem as permissões necessárias para acessar o recurso solicitado.
- Verifique a licença da conta. Talvez seja necessário atualizar a licença para usar este método da API.
- Verifique se o usuário pode realizar a mesma operação na interface.
Causa possível
A taxa de solicitações do mesmo endereço IP (5000/min) ou por usuário (400/min) excedeu o limite. As primeiras 400 solicitações por minuto são atendidas e qualquer valor acima disso retorna o status 429.
Etapas de solução de problemas
- Se você receber respostas HTTP 429 à sua solicitação, considere usar tentativas de novo (retries) com retardo exponencial.
- Divida a carga entre vários usuários.
- Se o problema persistir, entre em contato com nossa equipe de Suporte
Causa possível
O limite de solicitações foi excedido
Etapas de solução de problemas
Causa possível
- O servidor encontrou uma condição inesperada que o impediu de atender à solicitação.
- O usuário não tem acesso ao recurso solicitado
Etapas de solução de problemas
- Verifique a página de status do Wrike para ver se há problemas gerais.
- Se não houver incidentes, entre em contato com nossa equipe de Suporte para investigação adicional.
Causa possível
Você está tentando buscar um recurso que não existe.
Exemplo: Um usuário envia uma chamada para recuperar tarefas de uma pasta vazia com a chamada GET/folders/{folderId}/tasks
Etapas de solução de problemas
Certifique-se de que o recurso (por ex. tarefa/pasta/projeto, etc.) exista na conta.
Dicas Profissionais
Identificando a conta à qual seu token pertence
Gerenciando várias contas Wrike e não tem certeza a qual delas seu token está atribuído? Não se preocupe, é fácil descobrir. Basta executar a chamada GET/account para confirmar.
Rastreando o proprietário do seu token
Se você vem testando a API com vários usuários e deseja identificar o proprietário de um token específico, há uma maneira simples e direta. Recupere os detalhes de perfil do usuário enviando uma chamada GET/contacts?me=true.
Se os obstáculos persistirem, entre em contato com nossa equipe de Suporte e teremos prazer em ajudar você.
Para agilizar a resolução, forneça os seguintes detalhes:
- Seu objetivo com a chamada da API.
- A solicitação completa da API que você enviou.
- A resposta que você recebeu.
-
[Em caso de problemas relacionados a permissões ou token]
A parte do meio do token, para que possamos decodificá-lo do nosso lado.
Abaixo está um exemplo de um token de acesso. Precisamos que você nos envie a parte entre 2 pontos (destacada em negrito) e descarte as partes antes e depois do ponto:eyJ0dCI6InAiLCJhbGciOiJIUzI1NiIsInR2IjoiMSJ9.eyJkIjoie1wiYVwiOjM5MjA2MDIsXCJpXCI6NzIyMzMxOCxcImNcIjo0NjIwNzcwLFwidVwiOjY5NzA4NjcsXCJyXCI6XCJVU1wiLFwic1wiOltcIldcIixcIkZcIixcIklcIixcIlVcIixcIktcIixcIkNcIixcIkRcIixcIk1cIixcIkFcIixcIkxcIixcIlBcIl0sXCJ6XCI6W10sXCJ0XCI6MH0iLCJpYXQiOjE1OTk5MDk0MzV9.q3qOJs2swWSCgZl1ueKYsUyhME4RBD4cl53vZ0pwDccImportante
Nunca envie o token completo! Compartilhar seu token permanente equivale a compartilhar a senha da sua conta Wrike.