Ir para o conteúdo

Atividade de solicitação de API

Introdução

Uma atividade de Solicitação de API, usando sua conexão de API pré-configurada, recupera dados quando chamado por uma API Manager customizada API e se destina a ser usado como uma fonte para fornecer dados para uma operação.

A atividade API Request pode ser configurada usando um esquema JSON, XML, CSV ou XSD. Para interagir com uma conexão de API usando um esquema WSDL, use uma atividade API SOAP Request em vez de.

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

Criar uma atividade de solicitação de API

Uma instância de uma atividade de solicitação de API é criada a partir da conexão de API pré-configurada. usando seu tipo de atividade Request.

Para criar uma instância de uma atividade, arraste o tipo de atividade para a quadro de design ou copie o tipo de atividade e cole-o na quadro de design. Para obter detalhes, consulte Criar uma atividade ou instância de ferramenta em Reutilização de componentes.

Uma atividade de Solicitação de API existente pode ser editada nestes locais:

Configurar uma atividade de solicitação de API

Siga estas etapas para configurar uma atividade de Solicitação de API:

Etapa 1: insira um nome e especifique uma preferência de esquema de resposta

Nesta etapa, forneça um nome para a atividade e selecione uma preferência de esquema de resposta. Cada elemento de interface do usuário desta etapa é descrito abaixo.

Etapa 1 da configuração da atividade de solicitação de API

  • Nome: Insira um nome para identificar a atividade. O nome deve ser exclusivo para cada atividade de Solicitação de API e não deve conter barras / ou dois pontos :.

  • Fornecer esquema de resposta: O esquema de resposta define a estrutura de dados que é usada pela atividade Solicitação da API. Se um esquema é necessário depende se a atividade Solicitação da API é usada como a origem de uma transformação. Para obter instruções sobre como concluir esta seção de configuração da atividade, consulte Uso do esquema e Esquemas definidos em uma atividade.

  • Salvar e sair: Se habilitado, clique para salvar a configuração para esta etapa e fechar a configuração da atividade.

  • Próximo: Clique para armazenar temporariamente a configuração para esta etapa e continuar para a próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.

  • Descartar alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Etapa 2: Revise os esquemas de dados

Quaisquer esquemas de solicitação ou resposta gerados do endpoint são exibidos. Cada elemento de interface do usuário desta etapa é descrito abaixo.

Etapa 2 da configuração da atividade de solicitação de API

  • Esquemas de dados: Os esquemas de solicitação e resposta para esta atividade são exibidos. Esses esquemas de dados são herdados por transformações adjacentes e são exibidos novamente durante mapeamento de transformação.

  • Adicionar plugin(s): Plugins são aplicativos fornecidos pelo Jitterbit ou pelo usuário que estendem os recursos nativos do Harmony. Para aplicar um plugin à atividade, clique para expandir esta seção e marque a caixa de seleção ao lado do plugin a ser usado. Para obter instruções adicionais sobre o uso de plugins, incluindo detalhes sobre a configuração de quaisquer variáveis necessárias usadas pelo plugin, consulte Plugins adicionados a uma atividade.

  • Voltar: Clique para armazenar temporariamente a configuração para esta etapa e retornar à etapa anterior.

  • Concluído: Clique para salvar a configuração para todas as etapas e fechar a configuração da atividade.

  • Descartar alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme se deseja descartar as alterações.

Próximos passos

Após configurar uma atividade de Solicitação de API, conclua a configuração da operação adicionando e configurando outras atividades, transformações ou scripts como etapas da operação. Você também pode configurar as configurações da operação, que incluem a capacidade de encadear operações que estejam no mesmo fluxo de trabalho ou em workflows diferentes.

Depois que uma atividade de Solicitação de API é criada, as ações de menu para essa atividade ficam acessíveis no painel do projeto nas guias Workflows ou Componentes e na quadro de design. Consulte menu de ações de atividade para mais detalhes.

As atividades de Solicitação da API podem ser usadas como uma fonte com esses padrões de operação:

Nota

As operações que começam com uma atividade de Solicitação de API não podem ser executadas manualmente usando as opções de operação Deploy and Run ou Run. Em vez disso, essas operações exigem dados que são fornecidos quando uma chamada de API é feita usando uma API personalizada criada por meio do API Manager. Uma API pode ser chamada de um aplicativo ou — se a API suportar GET — você pode colar a URL em um navegador da Web para consumir a API manualmente.

Importante

Por padrão, as operações bem-sucedidas configuradas para uma API personalizada não estão incluídos nos registros de operação a menos que uma destas configurações esteja habilitada:

As operações malsucedidas são incluídas nos registros de operação se as configurações acima estão habilitadas ou não.

Configurar uma API personalizada do API Manager

Após a conclusão da configuração da operação, configure uma API personalizada usando API Manager.

Nota

Depois de configurar uma API personalizada para chamar an Integration Studio operação, você não pode excluir a operação sem excluir a API ou alterar a configuração da API para não chamar mais a operação.