Atividade de Resposta SOAP da API

Introdução

Uma atividade de Resposta SOAP da API, utilizando sua conexão de API pré-configurada, retorna dados para uma API personalizada do Gerenciador de API e é destinada a ser usada como um alvo para consumir dados em uma operação.

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

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

• Tipos de API do Gerenciador de API

• Configuração de API personalizada

• Construindo uma API personalizada simples

Criar uma atividade de Resposta SOAP da API

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

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 Resposta SOAP da API existente pode ser editada a partir destes locais:

• A tela de design (veja Menu de ações do componente em Tela de design).
• A aba Componentes do painel do projeto (veja Menu de ações do componente em Aba de Componentes do painel do projeto).

Configurar uma atividade de resposta API SOAP

Siga estas etapas para configurar uma atividade de Resposta SOAP da API:

• Etapa 1: Insira um nome e especifique as configurações
  Forneça um nome para a atividade e selecione o método a ser usado para fazer o upload do esquema WSDL.
• Etapa 2: Revise os esquemas de dados
  Quaisquer esquemas de solicitação ou resposta gerados a partir do endpoint são exibidos.

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

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

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

• URL de upload, Arquivo de upload ou Selecionar existente: Use o botão de opção para selecionar a fonte do arquivo WSDL (Linguagem de Descrição de Serviços Web) a ser enviado ou reutilizado. Arquivos de até 5 MB podem ser enviados.

  • URL de upload: Insira a URL do arquivo WSDL na caixa de texto e clique no botão Upload. A URL deve ser acessível sem autenticação, ou você receberá um erro. Se estiver fazendo o upload de um WSDL com o mesmo nome de um WSDL existente, consulte Possíveis erros mais adiante nesta página.

  • Arquivo de upload: Use o botão Procurar à direita para navegar localmente até um arquivo WSDL ou ZIP. Se fornecer um arquivo ZIP, ele deve conter um único arquivo WSDL, embora também possa conter quaisquer arquivos XSD dos quais o WSDL dependa. Em seguida, clique no botão Upload. Se estiver fazendo o upload de um WSDL com o mesmo nome de um WSDL existente, consulte Possíveis erros mais adiante nesta página.

    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ê deve fornecer:

    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 que está sendo carregado.

  • Selecionar existente: Use o dropdown para selecionar um arquivo WSDL existente que foi utilizado anteriormente no projeto atual.

• Porta: Use o dropdown para selecionar a porta apropriada.

• Serviço e Binding: 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 o dropdown para selecionar o método do WSDL fornecido que você deseja executar com esta 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 Finalizado 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 para você confirmar que deseja descartar as alterações.

Etapa 2: Revisar os esquemas de dados

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

• 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.

  Nota

  Os dados fornecidos em uma transformação têm precedência sobre a configuração da atividade.

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

• Finalizado: 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 pede para você confirmar que deseja descartar as alterações.

Possíveis erros

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

Não foi possível fazer upload do WSDL

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

Este WSDL não pode ser substituído porque está faltando operações WSDL que são usadas por atividades existentes. Exclua essas atividades da aba Componentes do painel do projeto e tente novamente.

Para resolver, assegure-se de que as operações WSDL tenham os mesmos nomes que quaisquer que estejam atualmente em uso por atividades existentes.

Falha ao implantar

Ao implantar uma operação cuja atividade de SOAP Request 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 Finalizar.

4. Implemente a operação.

Próximas etapas

Após configurar uma atividade de SOAP Response 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.

Ações de menu para uma atividade estão acessíveis a partir do painel do projeto e da tela de design. Para detalhes, veja o menu de ações da atividade em Conceitos básicos de conectores.

Atividades de Resposta SOAP da API podem ser usadas como um alvo com esses padrões de operação:

• Padrão de Arquivamento
• Padrão de Script
• Padrão de Transformação
• Padrão de Arquivamento com Dois Alvos (apenas como o segundo alvo)
• Padrão de Arquivamento HTTP com Dois Alvos (apenas como o segundo alvo)
• Padrão de Duas Transformações (apenas como o segundo alvo)

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

Configurar uma API personalizada no API Manager

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