Ir para o conteúdo

Atividade API SOAP Request no Jitterbit Studio

Introdução

Uma atividade API SOAP Request, usando sua conexão API pré-configurada, recupera dados quando chamada por uma API personalizada do API Manager e destina-se a ser usada como alvo para consumir dados em uma operação.

A atividade API SOAP Request pode ser configurada apenas usando um esquema WSDL. Para interagir com uma conexão API usando um esquema JSON, XML, CSV ou XSD, use uma atividade API Request não-SOAP. Para interagir com uma conexão SOAP sem usar uma API personalizada, use o conector SOAP.

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

Criar uma atividade API SOAP Request

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

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 mais detalhes, consulte Criar uma instância de atividade ou ferramenta em Reutilização de componentes.

Uma atividade API SOAP Request existente pode ser editada a partir destes locais:

Configurar uma atividade API SOAP Request

Siga estas etapas para configurar uma atividade API SOAP Request:

Etapa 1: Insira um nome e especifique configurações

Nesta etapa, forneça um nome para a atividade e selecione o método a ser usado para enviar o esquema WSDL. Cada elemento da interface de usuário desta etapa é descrito abaixo.

  • Name: Insira um nome para identificar a atividade. O nome deve ser único para cada atividade API SOAP Request e não deve conter barras / ou dois-pontos :.

  • Upload URL, Upload file, ou Select existing: Use o botão de opção para selecionar a fonte do arquivo WSDL a ser enviado ou reutilizado. É possível enviar arquivos com até 5 MB de tamanho.

    • Upload URL: Insira a URL do arquivo WSDL na caixa de texto e clique em Upload. A URL deve ser acessível sem autenticação. Se a URL exigir autenticação ou não retornar um arquivo WSDL válido, o Studio exibirá um erro no envio (consulte Requisitos de envio de WSDL). Se enviar um WSDL com o mesmo nome que um WSDL existente, consulte Possíveis erros mais adiante nesta página.

    • Upload file: Clique em Browse (localizado à direita) para procurar localmente um arquivo WSDL ou ZIP. Um arquivo ZIP pode conter quaisquer arquivos XSD dos quais o WSDL depende. Se o arquivo ZIP contiver mais de um arquivo WSDL, selecione o WSDL raiz quando solicitado. Em seguida, clique em Upload. Se o envio exibir um erro de validação, consulte Requisitos de envio de WSDL.

Nota

Qualquer schemaLocation deve ser resolvido para um arquivo local usando uma referência relativa. Isso geralmente significa que, em vez de fornecer uma tupla como:

xsi:schemaLocation='http://schemas.xmlsoap.org/wsdl/mime/ http://ws-i.org/profiles/basic/1.1/wsdlmime-2004-08-24.xsd'

você forneceria:

xsi:schemaLocation='http://schemas.xmlsoap.org/wsdl/mime/ wsdlmime-2004-08-24.xsd'

No exemplo acima, o arquivo XSD wsdlmime-2004-08-24.xsd está localizado no mesmo diretório ou em um caminho relativo ao WSDL sendo carregado.

  • Selecionar existente: Use a lista suspensa para selecionar um arquivo WSDL existente que foi usado anteriormente no projeto atual.

  • Porta: Use a lista suspensa para selecionar a porta apropriada.

  • Serviço e Vinculação: Por padrão, esses campos são preenchidos automaticamente com base no WSDL e na porta fornecidos e não podem ser editados.

  • Operação: Use a lista suspensa para selecionar o método do WSDL fornecido que deseja executar com esta atividade.

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

  • Próximo: Clique para armazenar temporariamente a configuração dessa etapa e continuar para a próxima. 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 solicita que você confirme que deseja descartar as alterações.

Etapa 2: Revisar os esquemas de dados

Todos os esquemas de solicitação ou resposta gerados a partir do endpoint são exibidos:

  • Esquemas de Dados: Os esquemas de solicitação e resposta dessa 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.

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

  • Concluído: Clique para salvar a configuração de todas as etapas e fechar a configuração de 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 que deseja descartar as alterações.

Erros possíveis

As seções a seguir cobrem erros que podem ocorrer durante a configuração de atividade.

Não foi possível fazer upload do WSDL

Ao substituir um WSDL fazendo upload novamente de um com o mesmo nome usando Upload de URL ou Upload de Arquivo, e as operações do WSDL de substituição não têm os mesmos nomes das usadas por atividades existentes, ou se as operações WSDL em uso estão faltando no WSDL de substituição, este erro pode ocorrer:

Texto da caixa de diálogo

Não foi possível fazer upload do WSDL
Este WSDL não pode ser substituído porque está faltando operações WSDL que são usadas pelas atividades existentes listadas abaixo. Exclua essas atividades da guia Componentes do painel de projeto e tente novamente.

  • Atividades que devem ser excluídas
    Atividade 1 (API)

  • Operações WSDL indefinidas que estão em uso por essas atividades
    Operação 1

Para resolver, verifique se as operações WSDL têm os mesmos nomes que aquelas atualmente em uso por atividades existentes.

Falha na implantação

Ao implantar uma operação cujo arquivo WSDL da atividade Solicitação SOAP foi substituído, você pode receber este erro:

Failed to deploy - Client Error: There is no uploaded file with client path ... Upgrade to the 8.4.0 Studio or higher and deploy the project again.

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 Concluído.

  4. Implante a operação.

Se em vez disso você receber Failed to deploy - Internal Error: No WSDL with locator, consulte Erro de implantação SOAP: "No WSDL with locator" no guia de resolução de problemas do Connector.

Próximas etapas

Após configurar uma atividade SOAP Request de API, conclua a configuração da operação adicionando e configurando outras atividades ou ferramentas como etapas da operação. Também é possível configurar as definições da operação, que incluem a capacidade de encadear operações que estão no mesmo workflow ou em workflows diferentes.

As ações de menu para uma atividade estão acessíveis no painel do projeto e na tela de design. Para obter detalhes, consulte Menu de ações da atividade em Noções básicas do conector.

As atividades SOAP Request de API podem ser usadas como destino com estes padrões de operação:

Quando pronto, implante a operação e valide o comportamento verificando os logs da operação.

Nota

Operações com uma atividade SOAP Request de API como primeira etapa da operação não podem ser executadas manualmente usando as opções Implantar e Executar ou Executar da operação. Em vez disso, essas operações exigem dados fornecidos quando uma chamada de API é feita usando uma API personalizada criada por meio do API Manager. Uma API pode ser chamada a partir de um aplicativo ou — se a API compatível com GET — é possível colar a URL em um navegador da Web para consumir a API manualmente.

Importante

Operações acionadas por uma API personalizada do API Manager têm registro adicional que pode ser habilitado. Para obter detalhes sobre o que aparece nos logs da operação e como habilitar registro adicional, consulte Dados de solicitação e resposta de API em Logs da operação.

Configurar uma API personalizada do API Manager

Após a operação ser configurada e implantada, configure uma API personalizada usando o API Manager.

Nota

Após configurar uma API personalizada para chamar uma operação do Studio, não é possível excluir a operação sem excluir a API ou alterar a configuração da API para não chamar mais a operação.