Todos os artigos

Resolver erros comuns da API REST

Situação

Ao trabalhar com a API do Wrike, erros são inevitáveis. 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, discutiremos alguns dos erros de API mais comuns e forneceremos etapas de solução de problemas para ajudar você a identificar e corrigir essas questões rapidamente.

Importante

Sempre confira duas vezes a documentação da API.

Respostas de Erro

A seguir está um exemplo comum de resposta de erro resultante de uma solicitação de API com falha.

Código de status: XXX
Corpo da resposta:

{\n\"errorDescription\": \"descrição legível por humanos do erro.\",\n\"error\": \"código curto, padronizado ou identificador para o erro específico que ocorreu\"\n}

Códigos de Status

300 - Multiple Choices

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.

400 - invalid_request

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

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.

400 - invalid_parameter

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.

400 - method_not_found

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.

403 - not_allowed

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 Collaborator tenta atualizar o título de uma pasta.
  • A operação não pode ser realizada.
    Exemplo: Um usuário tentou criar uma dependência já existente.

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.

404 - resource_not_found

Causa possível

  • O recurso solicitado não existe.
  • O usuário não tem acesso ao recurso solicitado

Etapas de solução de problemas

Verifique o recurso solicitado e certifique-se de que o usuário cujo token é usado para a integração tem acesso a ele.

429 - too_many_requests

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

429 - rate_limit_exceeded

Causa possível

O limite de solicitações foi excedido

Etapas de solução de problemas

Entre em contato com nossa equipe de Suporte

500 - server_error

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

Resposta vazia

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 usando 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ê estiver testando a API com vários usuários e quiser identificar o proprietário de um token específico, há uma maneira simples e direta. Recupere os detalhes do perfil do usuário enviando uma chamada GET/contacts?me=true.

Entrar em contato com o suporte

Se os obstáculos persistirem, por favor 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 token de acesso. Precisamos que você nos envie a parte entre dois pontos (destacada em negrito) e descarte as partes antes e depois do ponto:

    eyJ0dCI6InAiLCJhbGciOiJIUzI1NiIsInR2IjoiMSJ9.eyJkIjoie1wiYVwiOjM5MjA2MDIsXCJpXCI6NzIyMzMxOCxcImNcIjo0NjIwNzcwLFwidVwiOjY5NzA4NjcsXCJyXCI6XCJVU1wiLFwic1wiOltcIldcIixcIkZcIixcIklcIixcIlVcIixcIktcIixcIkNcIixcIkRcIixcIk1cIixcIkFcIixcIkxcIixcIlBcIl0sXCJ6XCI6W10sXCJ0XCI6MH0iLCJpYXQiOjE1OTk5MDk0MzV9.q3qOJs2swWSCgZl1ueKYsUyhME4RBD4cl53vZ0pwDcc

    Importante

    Nunca envie o token completo! Compartilhar seu token permanente equivale a compartilhar a senha da sua conta Wrike.

Topo

Artigos relacionados