Ir para o conteúdo

Conector de API

Resumo

O conector API tem uma conexão pré-configurada que fornece acesso às atividades da API. Essas atividades, uma vez configuradas, interagem com APIs personalizadas configurado em Harmony API Manager.

Este conector possui uma conexão pré-configurada e não requer configuração de conexão como é típico da maioria dos conectores Harmony.

Importante

Por padrão, operações de API bem-sucedidas (configuradas para APIs personalizadas ou Serviços OData) não estão incluídos nos logs de operação a menos que uma destas configurações esteja habilitada:

  • Agentes em Nuvem: Para operações de API em um Agente em Nuvem, registro de depurar de operação deve estar habilitado na operação.
  • Agentes Privados: Para operações de API em um Agente Privado, registro de depurar da operação deve estar habilitado na operação ou você deve definir EnableLogging=true no [APIOperation] seção do arquivo de configuração do Agente Privado.

    • O conector de API é acessado na aba endpoints e conectores da paleta de componentes de design (consulte Paleta de Componentes de Design).

    Visão Geral do Conector

    Este conector deve ser usado em conjunto com uma API Customizada do API Manager para expor uma operação ou um conjunto de operações como um endpoint REST consumível.

    Os tipos de atividades são usados para criar instâncias de atividades que devem ser usadas como fontes (fornecendo dados) ou alvos (recebendo dados) em uma operação.

    Juntas, a conexão de API pré-configurada e suas atividades são chamadas de endpoint de API:

    Tipos de atividades de API

    • Solicitar: Configurada usando um esquema JSON, XML, CSV ou XSD, esta atividade recupera dados quando chamada por uma API Customizada do API Manager e destina-se a ser usado como fonte de fornecimento de dados para uma operação.

    • Resposta: Configurada usando um esquema JSON, XML, CSV ou XSD, esta atividade retorna dados para uma API Customizada do API Manager e destina-se a ser usado como um destino para consumir dados em uma operação.

    • Solicitação SOAP: Configurada usando um esquema WSDL, esta atividade recupera dados quando chamada por uma API Customizada do API Manager e destina-se a ser usado como fonte de fornecimento de dados para uma operação.

    • Resposta SOAP: Configurada usando um esquema WSDL, esta atividade retorna dados para uma API Customizada do API Manager e destina-se a ser usado como um destino para consumir dados em uma operação.

    Nota

    Este conector é um conector nativo do Cloud Studio, que pode ser referido pelo Jitterbit ao comunicar alterações feitas nos conectores. O cronograma de lançamento para conectores nativos do Cloud Studio é baseado na cadência dos aplicativos em nuvem Harmony.

    Variáveis de Jitterbit da API

    Estas variáveis Jitterbit são fornecidas especificamente para uso com endpoints de API:

    Solução de Problemas

    Se você tiver problemas com o conector de API, estas etapas de solução de problemas são recomendadas:

    1. Garanta a conexão API é bem-sucedido usando o botão Test na tela de configuração. Se a conexão não for bem-sucedida, o erro retornado poderá fornecer uma indicação do problema.

    2. Verifique os logs de operação para qualquer informação escrita durante a execução da operação.

    3. Habilite o registro de depurar de operação (para Agentes em Nuvem ou para Agentes Privados) para gerar arquivos de log e dados adicionais.

    4. Se estiver usando Agentes Privados, você pode verificar os logs do agente Para maiores informações.

    Referência

    Para obter informações sobre o relacionamento entre atividades do conector de API e APIs do API Manager, consulte estes recursos: