API para Monitoramento

Guia de Teste API Monitoramento

Foi desenvolvida uma nova API, semelhante a uma existente no projeto de Leituras. Essa nova API será consultada externamente através do Postman. Abaixo, segue uma explicação detalhada de como obter as informações desejadas através dela.

1. Configuração da URL e Método

No Postman, configure a URL e o tipo de método que será utilizado. Para obter o token, utilize o método POST e a URL:

http://win13.cebisist:40010/login/connect/token

OBS: Troque a porta 40010 pela porta referente ao cliente em questão.

Na aba Headers, configure o Content-Type para application/x-www-form-urlencoded, conforme ilustrado na imagem abaixo:

Configuração Authorization

2. Configuração dos Parâmetros do Body

Na aba Body, selecione a opção x-www-form-urlencoded e configure os parâmetros conforme mostrado na imagem abaixo.

grant_type: client_credentials
scope: Cebi.Api
client_id: SeuClienteId
client_secret: SeuClienteSecret

Nota: Substitua SeuClienteId e SeuClienteSecret pelo usuário e senha do cliente em questão.

Após configurar, clique no botão Send para obter o token.

3. Configuração da Nova Requisição

Abra uma nova aba no Postman e configure a URL da API criada:

http://localhost:58000/leitura/Api/Rotas/PosicaoPorGrupo

Na aba Params, adicione os seguintes parâmetros:

grupoId: ID do grupo desejado
anoReferencia: Ano de referência (formato YYYY)
mesReferencia: Mês de referência (formato MM)

Importante: Certifique-se de que os nomes dos parâmetros estão exatamente como descritos acima.

4. Autorização

Na aba Authorization, selecione o tipo Bearer Token e insira o token gerado no passo 2 no campo Token.

Configuração Params

Clique no botão Send para fazer a chamada da API e obter as rotas desejadas.

Considerações Finais

Verifique as Configurações: Certifique-se de que todos os campos e parâmetros estão corretamente configurados antes de enviar a requisição.
Mensagens de Erro: Se a API retornar uma mensagem de erro, verifique novamente os parâmetros e o token.
Ambiente de Teste: Garanta que está utilizando o ambiente de teste correto, trocando a porta e URLs conforme necessário para cada cliente.

Com essas instruções, qualquer pessoa deve ser capaz de utilizar a API sem dificuldades. Se precisar de mais algum ajuste, sinta-se à vontade para pedir!