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:
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 Possíveis erros 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 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ê 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.
Possíveis erros
As seções a seguir abordam erros que podem ocorrer durante a configuração da atividade.
Não é possível carregar WSDL
Ao substituir um WSDL reenviando um com o mesmo nome usando Upload URL ou Upload File, e as operações do WSDL de substituição não tiverem o mesmo nome daquelas em uso pelas atividades existentes, ou se as operações do WSDL em uso estiverem ausentes do WSDL de substituição, este erro pode ocorrer:
This WSDL cannot be replaced because it is missing WSDL operations that are use by existing activities. Delete these activities from the project pane's Components tab and try again.
Para resolver, certifique-se de que as operações WSDL tenham o mesmo nome de todas as que estão em uso pelas atividades existentes.
Falha ao implantar
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:
-
Abra a atividade onde o arquivo WSDL foi substituído.
-
No passo 1, selecione novamente o arquivo WSDL a ser usado para a atividade e clique em Avançar.
-
Em etapa 2, clique em Concluir.
-
Implante a operação.
Próximos passos
Após configurar uma atividade API SOAP Response, conclua a configuração da operação adicionando e configurando outras atividades ou ferramentas como etapas de operação. Você também pode configurar as configurações de operação, que incluem a capacidade de encadear operações que estão no mesmo fluxo de trabalho ou em workflows diferentes.
As ações de menu para uma atividade são acessíveis a partir do painel do projeto e da quadro de design. Para obter detalhes, consulte menu de ações de atividade em Noções básicas do conector.
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)
Quando estiver pronto, implantar a operação e validar o comportamento verificando os logs de operação.
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:
- Agentes de nuvem: Para operações de API em um agente de nuvem, registro de depurar de operação deve ser habilitado na operação.
- Agentes privados: Para operações de API em um agente privado, registro de depurar da operação deve estar habilitado na operação ou você deve definir
EnableLogging=true
no[APIoperation]
seção do arquivo de configuração do agente privado.
Configurar uma API personalizada do API Manager
Depois que a operação for configurada e implantada, 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.