Atividade de resposta API SOAP

Introdução

Uma atividade de resposta SOAP da API, usando sua conexão de API pré-configurada, retorna dados para uma API Manager API personalizada e se destina a ser usado como um alvo para consumir dados em uma operação.

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

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

• Tipos de API do API Manager

• Configuração de API customizada

• Construindo uma API personalizada simples

Criar uma atividade de resposta SOAP da API

Uma instância de uma atividade de API Resposta SOAP é 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 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 API Resposta SOAP existente pode ser editada nestes locais:

• A quadro de design (veja menu de ações do componente em Tela de design).
• A aba Componentes do painel do projeto (consulte menu de ações do componente na aba Componentes do painel Projeto).

Configurar uma atividade de resposta SOAP da API

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

• 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 carregar o 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 carregar o 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 API SOAP Response 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 (Web Services Description Language) para upload ou reutilização. Arquivos de até 5 MB podem ser carregados.

  • 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 carregando um WSDL com o mesmo nome de um WSDL existente, consulte Substituir um WSDL carregado mais adiante nesta página.

  • Carregar arquivo: Use o botão Navegar à 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 seja dependente. Em seguida, clique no botão Carregar. Se estiver carregando um WSDL com o mesmo nome de um WSDL existente, consulte Substituir um WSDL carregado 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ê 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 que está sendo carregado.

  • Selecionar existente: Use o menu suspenso para selecionar um arquivo WSDL existente que tenha sido usado anteriormente no projeto atual.

• Porta: Use o menu suspenso 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 o menu suspenso 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 desta 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

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

  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 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 nenhuma etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Substituir um WSDL carregado

Se substituir um WSDL por recarregar um com o mesmo nome usando Upload URL ou Upload File, suas operações WSDL devem ter o mesmo nome de qualquer uma que esteja atualmente em uso por atividades existentes. Se elas não tiverem o mesmo nome ou se as operações WSDL em uso estiverem faltando no WSDL de substituição, uma mensagem de erro instruirá você a excluir essas atividades primeiro:

Se os critérios de substituição do WSDL descritos acima forem atendidos, uma mensagem de confirmação listará as atividades que podem ser impactadas pela substituição do WSDL e sugerirá a revisão de transformações adjacentes para possíveis erros de mapeamento. Clicar em Continuar substitui o WSDL em todos os locais onde ele é usado ao longo do projeto:

Próximos passos

Após configurar uma atividade API SOAP Response, 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 definiçõ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 API SOAP Response é criada, as ações de menu para essa atividade ficam acessíveis no painel do projeto nas guias Workflows ou Components e na quadro de design. Consulte menu de ações da atividade para mais detalhes.

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

• Padrão de arquivo
• Padrão de Script
• Padrão de Transformação
• Padrão de arquivo de dois alvos (apenas como o segundo alvo)
• Padrão de arquivo HTTP de dois alvos (apenas como o segundo alvo)
• Padrão de duas transformações (apenas como segundo alvo)

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.