Configurar uma fonte de dados Web Service
 |
 |
Pré-requisito
- Acesso ao menu Configuração > Fonte de dados Web Service (AD053).
Apresentação
O sistema disponibiliza um menu para que os usuários cadastrem todas as fontes de dados que realizarão a conexão do SoftExpert Suite com outros sistemas via Web Service.
Veja como efetuar a configuração das fontes de dados Web Service dentro do sistema:
Configurar fonte de dados Web Service
Veja mais detalhes sobre cada uma das etapas:
Dados do Web Service
• O botão Habilitado permite habilitar ou desabilitar o Web Service sem a necessidade de excluí-lo.
• Marque a opção Web service interno do SE Suite para selecionar um Web Service interno disponibilizado pelo SE Suite. Com isso, não será necessário criar uma nova fonte caso as configurações de domínio do ambiente sejam alteradas. Os campos Versão do WSDL e URL de conexão não estarão disponíveis, visto que estas informações serão definidas internamente.
• Exemplos de formatos de datas que podem ser utilizados:
| Formatação | Descrição | Exemplo |
| MM/dd/yyyy | Padrão americano de data | 06/22/2024 |
| dd/MM/yyyy | Padrão europeu de data | 15/03/2024 |
| HH:mm:ss | Horas, minutos e segundos | 18:37:05 |
| KK:mm:ss a | Horas, minutos e segundos (AM/PM) | 07:44:23 PM |
| dd/MM/yyyy HH:mm:ss | Data, horas, minutos e segundos | 26/12/2024 12:30:55 |
| dd/MM/yyyy KK:mm:ss a | Data, horas, minutos e segundos (AM/PM) | 12/07/2024 11:50:02 AM |
| EE MMM dd hh:mm:ss Z yyyy | Data descritiva, dia, horário (AM/PM), fuso horário e ano | Ter ago 16 12:00:00 BRT 2024 |
• Tipos de autenticação disponíveis para seleção:
| Anônimo | Não haverá necessidade de autenticação. |
| Autenticação básica | A autenticação se dará por usuário e senha no cabeçalho da requisição HTTP. Nos respectivos campos que serão habilitados, informe o Usuário e a Senha que serão utilizados para autenticação do serviço. Caso desejar, informe também o domínio que será utilizado. |
| WS-Security (Password Text) | O usuário e senha são enviados com a mensagem SOAP, para validar a comunicação entre o serviço e seu consumidor. Nos respectivos campos que serão habilitados, informe o Usuário e a Senha que serão utilizados para autenticação do serviço. |
| API key |
A autenticação se dará por um token no cabeçalho da requisição HTTP. Este tipo de autenticação deve ser usado apenas quando a fonte de dados cadastrada for um WSDL do SoftExpert Suite. No campo API key que será apresentado, informe o token do usuário que será utilizado para a operação. O token utilizado pode ser gerado por meio da seção API Gateway, da tela de dados do usuário, quando acessada pelo painel de usuário. Para mais informações sobre este tipo de autenticação, consulte o Guia de integração. |
• O campo URL de conexão não estará disponível se a opção Web service interno do SE Suite foi marcada.
Método
• Na hierarquia de parâmetros, é possível identificar o tipo de dado de cada parâmetro. Confira quais tipos de dados são suportados:
 |
TEXT |
 |
NUMERIC |
 |
DECIMAL |
 |
TIME |
 |
DATE |
 |
BOOLEAN |
 |
ENUM |
 |
BINARY |
• Especificações de Web Service não suportadas:
| Tipo de dados Array | Elementos que utilizam o tipo Array (por exemplo: soap-enc:Array) ou array através de colchetes (por exemplo: "element[]"). Recomenda-se utilizar o atributo maxOccurs="unbounded" para representar arranjos. |
| Retornos com estruturas dinâmicas | Métodos que têm retornos com estruturas dinâmicas, uma vez que não seria possível mapear os tipos definidos no retorno. |
| Tipos complexos aninhados com tag any | A tag <any> dentro de tags ComplexType aninhadas. Recomenda-se que cada ComplexType seja declarada de maneira independente, e que todos os elementos contenham o atributo type definido sem utilizar a tag <any>. |
| Herança de elementos com a tag Extension | O uso da tag <extension> para realizar herança entre ComplexTypes. Nesta situação, os elementos do ComplexType pai devem ser replicados nos filhos para obter-se o mesmo comportamento. |
Segurança
Na etapa Segurança, é possível definir uma lista de segurança para a fonte de dados Web Service, restringindo o acesso somente a quem for necessário.
Confira as opções disponíveis na aba:
Privado
Apenas os usuários definidos nesta aba poderão editar ou visualizar a fonte de dados Web Service. Para isso, utilize as seguintes colunas:
- Editar: defina os usuários, equipes, áreas e/ou funções que terão permissão para editar a fonte de dados.
- Visualizar: defina os usuários, equipes, áreas e/ou funções que terão permissão para visualizar a fonte de dados.
Público
Todos os usuários do sistema poderão visualizar a fonte de dados Web Service, porém, apenas os usuários definidos na respectiva coluna poderão editá-la. Por isso, a coluna Visualizar estará desabilitada (visto que a fonte de dados poderá ser visualizada por qualquer usuário).
Na coluna Editar, defina os usuários, equipes, áreas e/ou funções que terão permissão para alterar os dados da fonte de dados.
Resumo
Nesta etapa, é possível realizar o consumo dos métodos que foram habilitados. Após clicar no botão Teste de consumo, informe os valores dos parâmetros necessários para consumir o método e, em seguida, clique no botão Executar.
Podem ser apresentados dois tipos de resposta:
- Sucesso: o consumo foi realizado com sucesso. Neste caso, será possível visualizar um JSON contendo o retorno do serviço via SoftExpert Suite.
- Algo deu errado: ocorreu um problema ao consumir o serviço. Verifique se este está disponível e se os dados forem preenchidos corretamente nas etapas descritas anteriormente.
Conclusão
Pronto! Agora você já sabe como configurar uma fonte de dados Web Service dentro do sistema.