Validar informações em relação a como realizar a montagem da URL base para integração G5/BPM com a API-SXI
Problema
Após realizar o deploy da API-SXI a partir do site do Dev, como deve ser montada a URL base que fará a requisição da API de integração para os serviços externos?
Solução
Conforme especificado pelo site do Dev, existe uma definição de URL que deve ser utilizada nas requisições, o qual inicialmente deve ficar da seguinte forma:
http://<server>:<Porta>/<contexto-api>/<datasource>
Onde:
- Server: Servidor do Glassfish onde foi realizado o deploy do componente de integração.
- Porta: Porta de acesso ao servidor onde está a api de integração
- Contexto da API - É a informação relacionado ao parâmetro "Context-root" da aplicação da API que foi deployada.
Para obter esta informação, basta acessar a console do Glassfish e clicar e "Applications > SXI-API". Esta informação do parâmetro que deve ser utilizada na URL base do serviço.
- Datasource: Existem 2 tipos de datasources que podem ser configurados nas URLs base de integração:
- GenericConsult - Para requisições das portas relacionadas ao serviço "workflow.senior.ssf" que é importado com base nesta documentação. É uma API de consulta genérica disponibilizada pela Senior com algumas consultas já pré definidas, onde não é necessário a criação de um serviço externo customizado.
- G5Rest: Para realização de consultas de Serviços customizados pelo próprio cliente, onde o mesmo desenvolve um webservice para uma consulta ou persistência de informações de forma específica. De acordo com Esta Definição.
Como testar a API-SXI depois de realizado o deploy
Para realizar um teste de acesso, basta informar a URL base de integração no navegador conforme a especificação acima.
Por padrão, o retorno da requisição para o caso da API estar deployada corretamente é o ERRO 500, pois não é possível a resolução deste tipo de requisição via navegador.
Caso a consulta a URL base de integração retorne ERRO 404, deve se realizar o deploy novamente, ou verificar as informações relacionadas ao servidor, porta e contexto que estão sendo utilizados.
Após o teste de acesso, deve-se então seguir com os testes via Postman (https://www.getpostman.com/), realizando a definição das URLS completas para integração, conforme definidas nas documentações abaixo:
Para ambientes Cloud Senior:
Deve ser aberto um chamado para a equipe de suporte de cloud, solicitando as seguintes informações para que seja possível realizar a montagem das URLs dos serviços externos:
- Endereço externo do servidor
- Porta de acesso
- Contexto da API-SXI .