Ir para o conteúdo

Atividade de Solicitação de API

Introdução

Uma atividade de Solicitação de API, utilizando sua conexão de API pré-configurada, recupera dados quando chamada por uma API personalizada do Gerenciador de API e é destinada a ser usada como uma fonte para fornecer dados a uma operação.

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

Para informações sobre a relação entre atividades de conectores de API e APIs do Gerenciador de API, 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 Solicitação.

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

Uma atividade de Solicitação de API existente pode ser editada a partir destes 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 da interface do usuário desta etapa é descrito abaixo.

Configuração da atividade de solicitação de API etapa 1

  • 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 normais / ou dois pontos :.

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

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

  • Próximo: Clique para armazenar temporariamente a configuração desta 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 qualquer etapa. Uma mensagem pede que você confirme que deseja descartar as alterações.

Etapa 2: Revisar os esquemas de dados

Qualquer esquema de solicitação ou resposta gerado a partir do endpoint é exibido. Cada elemento da interface do usuário desta etapa é descrito abaixo.

Configuração da atividade de solicitação da API, etapa 2

  • 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 o mapeamento de transformação.

  • Adicionar plugin(s): Plugins são aplicativos fornecidos pela Jitterbit ou pelo usuário que ampliam as capacidades nativas do Harmony. Para aplicar um plugin à atividade, clique para expandir esta seção e selecione a caixa de seleção ao lado do plugin a ser utilizado. Para instruções adicionais sobre como usar 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 desta etapa e retornar à etapa anterior.

  • Concluído: Clique para salvar a configuração de 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 qualquer etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Próximas etapas

Após configurar uma atividade de Solicitação da API, complete a configuração da operação adicionando e configurando outras atividades ou ferramentas 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 estão no mesmo ou em diferentes fluxos de trabalho.

Uma vez que uma atividade de Solicitação da API tenha sido criada, as ações do menu para essa atividade estão acessíveis no painel do projeto nas abas Fluxos de Trabalho ou Componentes, e na tela de design. Consulte Menu de ações da atividade para mais detalhes.

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

Nota

Operações que começam com uma atividade de Solicitação da API não podem ser executadas manualmente usando as opções de operação Implantar e Executar ou Executar. Em vez disso, essas operações requerem dados que são fornecidos quando uma chamada de API é feita usando uma API personalizada criada através do Gerenciador de API. 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, operações bem-sucedidas configuradas para uma API personalizada não estão incluídas nos logs de operação a menos que uma dessas configurações esteja habilitada:

Operações malsucedidas estão incluídas nos logs de operação independentemente de as configurações acima estarem habilitadas ou não.

Configurar uma API personalizada do API Manager

Uma vez que a operação esteja configurada e implantada, configure uma API personalizada usando API Manager.

Nota

Depois de configurar uma API personalizada para chamar uma operação do Integration Studio, 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.