01.VISÃO GERAL
...
O objetivo dessa documentação é realizar uma validação de serviços básicos do Meu RH, visando monitorar e identificar problemas de ambiente.
As collections disponibilizadas abaixo realizam as seguintes validações:
- Comunicação entre o Client e o Host Server (Consumo de API´S do host pelo FrameHTML através do Health Check)
- Login - validando se o login está sendo realizada da maneira correta (Retornando o token de autenticação)
- Inconsistência na comunicação envolvendo o CORS, realizando a mesma requisição do aplicativo, verificando se os cabeçalhos estão corretos
- Verificar se a API de usuário logado está respondendo corretamente, pois esta API é a primeira API que pode ocasionar problemas ao carregar as outras API da HOME, por exemplo. (Se este item não responder pode ocasionar tela branca no app)
- API que exige autenticação, serviço que retorna o contexto do usuário.
Através de um health check é possível verificar o conteúdo de requisições e respostas para checar se um determinado recurso HTTP está funcionando corretamente.
02.COMO FUNCIONA A API DE HEALTH CHECK DO MEU RH
A API de Health Check do Meu RH valida se o ambiente do servidor de aplicação possui um funcionamento correto, principalmente com relação às informações de CORS utilizada pelo app Meu RH. Para saber mais sobre CORS clique aqui
03.PASSO A PASSO PARA
...
EXECUÇÃO DAS COLLECTIONS DE VALIDAÇÃO DE SERVIÇOS
Com intuito de validar o ambiente dos clientes para o funcionamento correto, foi desenvolvido um script do Postman que simula o comportamento do app.
...
- Realizar o download do Postman através do link:
https://www.postman.com/downloads/ - Após a instalação do software, fazer o download do script de execução. Existem dois tipos de scripts.
2.1 - Um deles simula o comportamento do app realizando as chamadas para as API’s via camadas do servidor web (Zona DMZ) Clique aqui e faça o download da collection.
2.2 - O outro simula requisições realizadas diretamente para o host e deve ser executado de um local que consiga acessar o servidor onde a aplicação (host) está instalada (Meu RH - RM Host API): Clique aqui e faça o download da collection.
04.UTILIZANDO O SCRIPT MeuRH (Zona DMZ)
1. Ao abrir o Postman e clicar no menu File >> Import
...
OBS: Preencher os valores nas colunas “INTIAL VALUE” e “CURRENT VALUE”
4. 0 Após preencher os parâmetros, salve o arquivo (CTRL + S) e execute o script
...
Em seguida selecione a opção Run Meu RH - Ionic 5
![](/download/attachments/844981132/image-2024-5-22_16-12-54.png?version=1&modificationDate=1716405174337&api=v2)
5. 0 Caso tudo esteja OK, todos os testes irão passar corretamente
![](/download/attachments/844981132/image-2024-5-22_16-17-5.png?version=1&modificationDate=1716405431693&api=v2)
6. 0 Caso haja algum erro, o script irá apontar em qual requisição está dando problema.
![](/download/attachments/844981132/image-2024-5-22_16-17-44.png?version=1&modificationDate=1716405467803&api=v2)
7. 0 Para auxiliar na verificação dos erros, acessar o console.
![](/download/attachments/844981132/image-2024-5-22_16-19-23.png?version=1&modificationDate=1716405564077&api=v2)
...
- Comunicação entre o Client e o Host Server (Consumo de API´S do host pelo FrameHTML)
- Login - validando se o login está sendo realizada da maneira correta (Retornando o token de autenticação)
- Inconsistência na comunicação envolvendo o CORS, realizando a mesma requisição do aplicativo, verificando se os cabeçalhos estão corretos
- Verificar se a API de usuário logado está respondendo corretamente, pois esta API é a primeira API que pode ocasionar problemas ao carregar as outras API da HOME, por exemplo. (Se este item não responder pode ocasionar tela branca no app)
- API que exige autenticação, serviço que retorna o contexto do usuário.
Observação: Caso tenha balanceamento no servidor web, e um determinado servidor de host esteja inativo, o serviço irá procurar outro servidor de host ativo para retornar o resultado, para verificar se um serviço de host está ativo, deverá seguir o passo a passo do item 05.
05.UTILIZANDO O SCRIPT MeuRH (RM Host API)
1. Ao abrir o Postman e clicar no menu File >> Import
Image Added
2. No lado esquerdo, será exibido o script com o nome “Meu RH - RM Host API”. Ao clicar com o mouse em cima do script, será aberto as configurações:
Image Added
3. Selecionar a aba “Variables”, onde serão exibidos os parâmetros para o script de execução.
Image Added
base_url: A url REST responsável por realizar a requisição.
port: A API Port utilizada (Definida no host manager)
sufix: api/rh/v1 ou rm/api/rh/v1 (depende da configuração)
user: Usuário utilizado para realizar o login
password: Senha utilizada para realizar o login
A base_url é montada no seguinte formato: {PROTOCOLO}://{ENDEREÇO}:{{port}}/
- PROTOCOLO: HTTP ou HTTPS
- ENDEREÇO: URL base de acesso
- port: Variável do Postman que é definida logo abaixo
- Exemplo: http://192.168.1.140:{{port}}
- port: A API Port utilizada (Definida no host manager)
4. Após preencher os parâmetros, salve o arquivo (CTRL + S) e execute o script
Image Added
Em seguida selecione a opção Run Meu RH - RM Host API
Image Added
5. Caso esteja tudo OK, todos os testes irão passar corretamente.
Image Added
6. Caso haja algum erro, o script irá apontar em qual requisição está dando problema.
Image Added
7. Para auxiliar na verificação dos erros, acessar o console.
Image Added
Os itens analisados pelo script são:
- Comunicação entre o Client e o Host Server (Consumo de API´S do host pelo FrameHTML)
- Login - validando se o login está sendo realizada da maneira correta (Retornando o token de autenticação)
- Verificar se a API de usuário logado está respondendo corretamente, pois esta API é a primeira API que pode ocasionar problemas ao carregar as outras API da HOME, por exemplo. (Se este item não responder pode ocasionar tela branca no app)
- API que exige autenticação, serviço que retorna o contexto do usuário