Solucionando Problemas

Guia completo de solução de problemas para integração da API REST.

Solucionando Problemas

Tabela 1. Problemas comuns e soluções
Emitir Possível Causa Resolução
Opção da API REST desativada na interface do usuário Recurso não ativado Configure yfs.sdf.restapi.enabled=Y e reinicie o OMS
Cabeçalhos não propagados Não está na lista de permissões Adicionar cabeçalhos à yfs.rest.allowed.headers propriedade
401 Erros de acesso não autorizado Credenciais inválidas Verifique o token JWT, a configuração do ` OAuth ` ou a importação do certificado
Erros 404 Não encontrado URL errado Verifique se a API externa URL está correta
Variáveis não resolvidas Erro de sintaxe Verificar sintaxe: ${prop}, /xpath, $.json, #{h:header}, #{q:param}
O JSON não está funcionando Configuração ausente Adicionar serviço ao yfs.xmljson.wrapjson.forflows imóvel
Tempo limite de conexão Problema de rede/firewall Verifique a conectividade da rede e aumente o tempo de espera
Erros de certificado com autenticação desativada Certificado não importado Importar certificado de API externo para o armazenamento de chaves do OMS
OAuth Falha na atualização do token Configuração inválida do ` OAuth ` Verifique o ID do cliente, o segredo e o token URL

Perguntas mais Frequentes

Posso usar a autenticação JWT?

Sim, mas o JWT não está disponível no menu suspenso da interface do usuário. Configure-o usando cabeçalhos personalizados com o Authorization header.

Como faço para adicionar cabeçalhos personalizados à lista de permissões?

Defina a yfs.rest.allowed.headers propriedade com nomes de cabeçalhos separados por vírgulas. O valor padrão é Authorization,Content-Type,Accept,X-*.

Posso substituir os cabeçalhos das mensagens recebidas?

Sim, especificando um valor diferente na definição do serviço. O valor configurado tem prioridade.

E se minha API exigir autenticação básica?

Configure-o usando cabeçalhos personalizados com Authorization: Basic <base64-encoded-credentials>.

Como posso verificar se o recurso está ativado?

Acesse a interface de definição de serviço > Adicionar API e verifique se o botão de opção API REST está habilitado e não desativado (em cinza).

Posso usar tanto o XPath quanto o JSONPath no mesmo serviço?

Sim, mas o XPath só funciona com dados em XML e o JSONPath só funciona com dados em JSON.

Como faço para resolver problemas relacionados à resolução variável?

Ative o registro de depuração com yfs.yfs.10=verbose e verifique os registros para obter detalhes sobre a resolução das variáveis.

Como obter ajuda

  • Verifique os registros para obter mensagens de erro detalhadas
  • Entre em contato com o suporte do IBM, enviando os arquivos de log e os detalhes de configuração
  • Consulte a documentação para ver exemplos de configuração
  • Teste APIs externas de forma independente para identificar problemas