Ir para o conteúdo

Conector de API para Jitterbit Studio

Resumo

O conector de API expõe uma operação ou um conjunto de operações como um endpoint REST consumível. Ele vem com uma conexão pré-configurada que não requer configuração de conexão, como é típico para a maioria dos conectores Harmony. Essa conexão fornece acesso a atividades de API que, uma vez configuradas, interagem com APIs personalizadas configuradas no Jitterbit API Manager.

O conector de API é acessado na aba Endpoints e conectores do projeto na paleta de componentes de design (veja Paleta de componentes de design).

Para informações sobre a relação entre as atividades do conector de API e as APIs do API Manager, consulte estes recursos:

Importante

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

  • Agentes em nuvem: Para operações de API em um agente em nuvem, o registro de depuração de operação deve estar habilitado na operação.
  • Agentes privados: Para operações de API em um agente privado, ou o registro de depuração de operação deve estar habilitado na operação ou você deve definir EnableLogging=true na seção [APIoperation] do arquivo de configuração do agente privado.

    • Visão geral do conector

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

    Os tipos de atividade são usados para criar instâncias de atividades que se destinam a ser usadas como fontes (para fornecer dados em uma operação) ou alvos (para consumir dados em uma operação).

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

    API activity types

    • Request: Configurada usando um esquema JSON, XML, CSV ou XSD, esta atividade recupera dados quando chamada por uma API Manager custom API e é destinada a ser usada como uma fonte para fornecer dados a uma operação.

    • Response: Configurada usando um esquema JSON, XML, CSV ou XSD, esta atividade retorna dados a uma API Manager custom API e é destinada a ser usada como um alvo para consumir dados em uma operação.

    • SOAP Request: Configurada usando um esquema WSDL, esta atividade recupera dados quando chamada por uma API Manager custom API e é destinada a ser usada como uma fonte para fornecer dados a uma operação.

    • SOAP Response: Configurada usando um esquema WSDL, esta atividade retorna dados a uma API Manager custom API e é destinada a ser usada como um alvo para consumir dados em uma operação.

    Nota

    Este conector é um conector nativo do Studio, que pode ser referido pela Jitterbit ao comunicar alterações feitas nos conectores. O release schedule para conectores nativos do Studio é baseado na cadência das aplicações web do portal Harmony.

    Os endpoints criados com este conector não contam para sua licença e não estão incluídos no relatório de uso de endpoints.

    Variáveis da API Jitterbit

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

    Resolução de Problemas

    Se você encontrar problemas com o conector da API, recomenda-se seguir estas etapas de resolução de problemas:

    1. Certifique-se de que a conexão da API foi bem-sucedida usando o botão Testar na tela de configuração. Se a conexão não for bem-sucedida, o erro retornado pode fornecer uma indicação do problema.

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

    3. Ative o registro de depuração da operação (para agentes em nuvem ou para agentes privados) para gerar arquivos e dados de log adicionais.

    4. Se estiver usando agentes privados, você pode verificar os logs do agente para mais informações.

    5. Para considerações adicionais de resolução de problemas, consulte Resolução de Problemas de Operação.

    6. Solicitação SOAP e Atividades de Resposta SOAP: Ao implantar uma operação cuja atividade de Solicitação SOAP ou Resposta SOAP teve seu arquivo WSDL substituído, você pode receber este erro:

      Falha ao implantar - Erro do Cliente: Não há arquivo enviado com o caminho do cliente ... Atualize para o Studio 8.4.0 ou superior e implante o projeto novamente.

      Para resolver, siga estas etapas:

      1. Abra a atividade onde o arquivo WSDL foi substituído.

      2. Na etapa 1, selecione novamente o arquivo WSDL a ser usado para a atividade e clique em Próximo.

      3. Na etapa 2, clique em Concluir.

      4. Implemente a operação.