Diferenças

Aqui você vê as diferenças entre duas revisões dessa página.

--- envio_de_alertas [2024/08/26 15:29] – [Documentação via JSON] luiz.amaral
+++ envio_de_alertas [2025/09/03 14:25] (atual) – guilherme.bassan
@@ Linha 1: / Linha 1: @@
-{{ :api_alertas_documentacao.zip |}}
+===== Envio de Alertas =====
-===== Introdução =====
 O objetivo é o envio de alertas de comunicação e de energia.
@@ Linha 7: / Linha 5: @@
 Este módulo contem endpoints para o envio de informações ao Lote 9.
-===== Endpoint de comunicação =====
+A conexão é realizada por https, com um certificado gerado pelo próprio Lote 09, ou seja, não é verificado por uma autoridade de certificação (CA), o que significa que na implementação é preciso desativar essa verificação. Como exemplo em python, utilizando a biblioteca ''requests'', é preciso desativar a flag ''verify'':
+''resposta = request(method="POST", url=url, headers=headers, data=payload, verify=False)''
-Todos os equipamentos dos consórcios precisam enviar uma requisição ao lote 9 no intervalo minímo de 5 minutos. Recomendamos que essa requisição seja enviado a cada 2 ou 3 minutos para garantir o processamento no tempo esperado.
+===== Aviso =====
-  * Regra: Se não houver o envio desta requisição no tempo determinado, será gerado um alerta de equipamento sem comunicação com o Lote 9. Este alerta será apresentado ao sistema WEB do Lote 9 num formato de toast (alerta no browser).
+Será realizada uma manutenção na API de recebimento de alertas no dia 03/09/2025, podendo haver instabilidade no sistema das 14h30 às 15h30.
+===== Autenticação =====
-===== Endpoint de Energia =====
+Por segurança na comunicação dos equipamentos com o Lote 9 é necessário realizar autenticação. Para isso, usamos o JWT e Bearer Authentication. Para mais informações sobre usuário e senha, favor entrar em contato com a CET que encaminhará a solicitação ao Lote 9.\\
+\\
+Para a autenticação, é necessário informar o usuário, a senha e o serial do dispositivo, passando o usuário no campo ''username'', a senha no campo ''password'' e o serial no campo ''client_id''.
+Como exemplo em python, o payload do request fica da seguinte forma:\\
+''payload = f"grant_type=password&username={usuario}&password={senha}&scope=&client_id={serial}&client_secret="''
-Todos os equipamentos dos consórcios precisam enviar uma requisição ao lote 9 quando da falta de energia comercial (funcionamento por nobreak). Quando houver o retorno de energia comercial, uma requisição também deverá ser enviado.
+Caso as credenciais estejam corretas, um token de acesso e um token de reconexão são devolvidos para o local especificado.
-  * Regra: Na ocasião do envio da falta ou retorno de energia no equipamento, será gerado um alerta. Este alerta será apresentado ao sistema WEB do Lote 9 num formato de toast (alerta no browser).
+O token de acesso é utilizado para os endpoints de comunicação e energia e possui um tempo de expiração de 15 minutos.
+O token de reconexão é utilizado para manter a conexão ativa sem a necessidade de um novo login, este token possui um tempo de expiração de 20 minutos e é utilizado no endpoint ''refresh-token''.\\
+\\
+Obs.: Os tokens são únicos para cada local e é de suma importância armazenar os tokens recebidos com segurança.\\
-===== Autenticação =====
+===== Reconexão =====
-Por segurança na comunicação dos equipamentos com o Lote 9 é necessário realizar autenticação. Para isso, usamos o JWT e Bearer Authentication. Para mais informações sobre usuário e senha, favor entrar em contato com a CET que encaminhará a solicitação ao Lote 9.
+O endpoint ''refresh-token'' recebe um token de reconexão, checa sua expiração e se estiver válido, retorna um novo token de acesso e um novo token de reconexão.\\
+\\
+Para evitar que requisições retornem com erro por expiração do token de acesso, é recomendado que a atualização dos tokens seja realizada antes da expiração do token de acesso.
+===== Endpoint de Comunicação =====
+O endpoint ''comunicacao'' recebe o número serial e o token de acesso, checa a validade do token e retorna uma indicação do sucesso da requisição.\\
+\\
+O status de comunicação de cada dispositivo expira em 5 minutos. Recomendamos que essa requisição seja enviado a cada 2 ou 3 minutos para garantir o processamento no tempo esperado.
+  * Regra: Se não houver o envio desta requisição no tempo determinado, será gerado um alerta de equipamento sem comunicação com o Lote 9.
+===== Endpoint de Energia =====
+O endpoint ''energia'' recebe o serial do equipamento, o estado da energia e o token de acesso, checa a validade do token e retorna uma indicação do sucesso da requisição.\\
+\\
+Todos os equipamentos dos consórcios precisam enviar uma requisição ao lote 9 quando da falta de energia comercial (funcionamento por nobreak). Quando houver o retorno de energia comercial, uma requisição também deverá ser enviado.
+  * Regra: Na ocasião do envio da falta ou retorno de energia no equipamento, será gerado um alerta.
 ===== Documentação via JSON =====
@@ Linha 28: / Linha 51: @@
   * Para visualizar a estrutura, pode ser usado o software online https://jsonviewer.stack.hu/ colando o json na tab "Text", e observando a estrutura na tab "Viewer".
-{{ :api_alertas_documentacao.zip |}}
+{{ :openapi.zip |}}