Conector de API no 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. Esta 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 a partir da aba Endpoints e conectores do projeto da paleta de componentes de design (consulte Paleta de componentes de design).

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

• Tipos de API do API Manager

• Configuração de API personalizada

• Criando uma API personalizada simples

Visão geral do conector

Este conector é destinado a ser usado em conjunto com uma API personalizada do API Manager 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 destinadas a serem usadas como fontes (para fornecer dados em uma operação) ou destinos (para consumir dados em uma operação).

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

• Request: Configurada usando um esquema JSON, XML, CSV ou XSD, esta atividade recupera dados quando chamada por uma API personalizada do API Manager 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 personalizada do API Manager e é destinada a ser usada como um destino para consumir dados em uma operação.

• SOAP Request: Configurada usando um esquema WSDL, esta atividade recupera dados quando chamada por uma API personalizada do API Manager 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 personalizada do API Manager e é destinada a ser usada como um destino para consumir dados em uma operação.

Este conector pode ser usado com agentes na nuvem e agentes privados.

Este conector é um conector nativo: suas atualizações são lançadas com a aplicação Studio ou o agente em vez de separadamente. Consulte Atualizações de conectores do Studio.

Os endpoints criados com este conector são excluídos do relatório de uso de endpoints e da contagem de licenças.

Variáveis Jitterbit da API

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

• jitterbit.api.request.body e jitterbit.api.request.body.*

• jitterbit.api.request.enum.body

• jitterbit.api.request.enum.headers

• jitterbit.api.request.enum.mvparameters

• jitterbit.api.request.enum.parameters

• jitterbit.api.request.headers.*

• jitterbit.api.request.headers.fulluri

• jitterbit.api.request.method

• jitterbit.api.request.mvparameters.*

• jitterbit.api.request.parameters.*

• jitterbit.api.response

• jitterbit.api.response.headers.*

• jitterbit.api.response.headers.content_type

  Nota

  Quando um endpoint requer uma codificação de caracteres específica, jitterbit.source.text.character_encoding e jitterbit.target.text.character_encoding também podem ser necessárias. Estas, juntamente com qualquer variável que afete a resposta da API, devem ser definidas em um script anterior a qualquer transformação na operação. Isso inclui variáveis como jitterbit.api.response.headers.content_type.

• jitterbit.api.response.status_code

Solução de problemas

Se você enfrentar problemas com o conector de API, recomenda-se seguir estas etapas de solução de problemas:

1. Verifique se a conexão de API foi bem-sucedida usando o botão Test 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 da operação para qualquer informação registrada durante a execução da operação.

3. Ative o log de debug da 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 obter mais informações.

5. Para considerações adicionais sobre solução de problemas, consulte Solução de problemas de operação.

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

Falha na implantação - Erro do cliente: Não há arquivo enviado com 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. Implante a operação.