Como resolver o erro "Invalid payload" na integração de API

Aprenda como resolver o erro de payload inválido na integração de API.

Encontrar erros durante o desenvolvimento de software e a integração de APIs é algo comum. Um problema frequente é o erro “Invalid payload”, geralmente acompanhado por uma mensagem como:

errorMessage: Invalid payload. Error: Unexpected character ('<' (code 60)): expected a valid value

O que causa o erro?

A principal causa desse erro é a incompatibilidade entre o formato de dados esperado e o formato real recebido do serviço externo. Quando o conector espera dados em JSON, mas recebe outro formato, como XML, ele não consegue processar a resposta corretamente, resultando no erro Invalid payload.

Como resolver o problema?

Corrigir o erro Invalid payload envolve identificar e alinhar os formatos de dados esperados e recebidos. Siga estas etapas para solucionar o problema:

1. Identifique a origem: Descubra qual endpoint ou serviço externo está retornando um formato de dados inesperado. Você pode fazer isso analisando a mensagem de erro e rastreando sua origem.

2. Ative o Advanced Settings: Acesse as configurações do conector que está gerando o erro e habilite o Advanced Settings.

3. Ative o Raw Mode: Depois de ativar o Advanced Settings, habilite o Raw Mode. Isso permitirá visualizar a resposta bruta enviada pelo serviço externo.

4. Salve e implante: Salve as alterações e implante a nova versão do conector. Na próxima vez que o erro ocorrer, os detalhes serão exibidos no formato enviado pelo endpoint externo, facilitando a identificação da causa do problema.

Conclusão

O erro Invalid payload é um obstáculo comum na integração de APIs, geralmente causado por discrepâncias entre os formatos de dados do conector e do serviço externo. Compreendendo a causa raiz do erro e seguindo as etapas acima, você pode resolvê-lo de forma eficaz e garantir uma comunicação fluida entre a aplicação e serviços externos.