Base de Conhecimento de Gestão Comercial de Saneamento

A maior base de documentação de GSAN do mercado mantida pela Consenso Tecnologia

Ferramentas do usuário

Ferramentas do site

Visitou: • prf • api
postgres:boto-nlp:api

Diferenças

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

Link para esta página de comparações

Ambos lados da revisão anteriorRevisão anterior
Próxima revisão		Revisão anterior
postgres:boto-nlp:api [02/08/2022 15:16] – tadeu.sarmentopostgres:boto-nlp:api [02/08/2022 16:18] (atual) – tadeu.sarmento
Linha 10: Linha 10:
 <columns> <columns>
 Escolha abaixo o serviço que deseja ver a **A.P.I** de integração: Escolha abaixo o serviço que deseja ver a **A.P.I** de integração:
 +  - **[[=postgres:boto-nlp:api#validacao_integracao_-_status|Validação / Integração - Status]]**
   - **[[=postgres:boto-nlp:api#login_autenticacao|Login/Autenticação]]**   - **[[=postgres:boto-nlp:api#login_autenticacao|Login/Autenticação]]**
   - **[[=postgres:boto-nlp:api#segunda_via_de_contas|Segunda Via de Contas]]**   - **[[=postgres:boto-nlp:api#segunda_via_de_contas|Segunda Via de Contas]]**
Linha 16: Linha 17:
 </columns> </columns>
 \\ \\
 +===== Validação/Integração - Status =====
 +<columns>
 +**A.P.I** responsável por informar se o sistema comercial está online e apto a receber requisições.
 +</columns>
 +\\
 +
 +==== GET /gsan/verificarBot ====
 +<columns>
 +**A.P.I** para obter o status do serviço do sistema comercial.
 +
 +\\
 +
 +**Resposta esperada**:
 +
 +  - **body**: valor booleano
 +\\
 +
 +Exemplo:
 +</columns>
 +
 +<WRAP center round box 100%>
 +{{  :postgres:boto-nlp:11111.jpg?nolink  |}}
 +<html><center> Figura 1 exemplo de request para a rota /gsan/verificarBot</center></html>
 +</WRAP>
 +\\
 +
  
 ===== Login/Autenticação ===== ===== Login/Autenticação =====
Linha 44: Linha 71:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:figura_1.jpg?nolink  |}} {{  :postgres:boto-nlp:figura_1.jpg?nolink  |}}
-<html><center> Figura 1 Exemplo de request para a rota /gsan/localidadeImovel</center></html>+<html><center> Figura 2 Exemplo de request para a rota /gsan/localidadeImovel</center></html>
 </WRAP> </WRAP>
 \\ \\
Linha 69: Linha 96:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:figura_2.jpg?nolink  |}} {{  :postgres:boto-nlp:figura_2.jpg?nolink  |}}
-<html><center> Figura 2 Exemplo de request para a rota /gsan/buscarImoveis</center></html>+<html><center> Figura 3 Exemplo de request para a rota /gsan/buscarImoveis</center></html>
 </WRAP> </WRAP>
 \\ \\
Linha 94: Linha 121:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:figura_3.jpg?nolink  |}} {{  :postgres:boto-nlp:figura_3.jpg?nolink  |}}
-<html><center> Figura 3: Exemplo de request para a rota /gsan/verificarMatriculaCpfCnpj</center></html>+<html><center> Figura 4: Exemplo de request para a rota /gsan/verificarMatriculaCpfCnpj</center></html>
 </WRAP> </WRAP>
 \\ \\
Linha 112: Linha 139:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:figura_4.1.jpg?nolink  |}} {{  :postgres:boto-nlp:figura_4.1.jpg?nolink  |}}
-<html><center> Figura 4.1: Exemplo de request para a rota /gsan/chatbot/autenticarMatricula</center></html>+<html><center> Figura 5.1: Exemplo de request para a rota /gsan/chatbot/autenticarMatricula</center></html>
 </WRAP> </WRAP>
  
Linha 127: Linha 154:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:figura_4.2.jpg?nolink  |}} {{  :postgres:boto-nlp:figura_4.2.jpg?nolink  |}}
-<html><center> Figura 4.2: Exemplo de request para a rota /gsan/chatbot/autenticarMatricula</center></html>+<html><center> Figura 5.2: Exemplo de request para a rota /gsan/chatbot/autenticarMatricula</center></html>
 </WRAP> </WRAP>
  
-**Observação**: No exemplo **4.2** o código de status da resposta é **422**.+**Observação**: No exemplo **5.2** o código de status da resposta é **422**.
 \\ \\
  
Linha 158: Linha 185:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:figura_5.jpg?nolink  |}} {{  :postgres:boto-nlp:figura_5.jpg?nolink  |}}
-<html><center> Figura 5: Exemplo de request para a rota /gsan/segundaViaConta</center></html>+<html><center> Figura 6: Exemplo de request para a rota /gsan/segundaViaConta</center></html>
 </WRAP> </WRAP>
 \\ \\
Linha 182: Linha 209:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:figura_6.jpg?nolink  |}} {{  :postgres:boto-nlp:figura_6.jpg?nolink  |}}
-<html><center> Figura 6: Exemplo de request para a rota /gsan/segundaViaContaTotal</center></html>+<html><center> Figura 7: Exemplo de request para a rota /gsan/segundaViaContaTotal</center></html>
 </WRAP> </WRAP>
 \\ \\
Linha 188: Linha 215:
 ==== GET /gsan/segundaViaCodigoBarra ==== ==== GET /gsan/segundaViaCodigoBarra ====
 <columns> <columns>
-**A.P.I** para obter os códigos de barras das contas informadas. Parâmetros:+**A.P.I** para obter os códigos de barra das contas informadas. Parâmetros:
  
   - **matricula**: valor inteiro com a identificação do imóvel no sistema comercial.   - **matricula**: valor inteiro com a identificação do imóvel no sistema comercial.
Linha 210: Linha 237:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:figura_7.jpg?nolink  |}} {{  :postgres:boto-nlp:figura_7.jpg?nolink  |}}
-<html><center> Figura 7: Exemplo de request para a rota /gsan/segundaViaCodigoBarra</center></html>+<html><center> Figura 8: Exemplo de request para a rota /gsan/segundaViaCodigoBarra</center></html>
 </WRAP> </WRAP>
  
Linha 237: Linha 264:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:figura_8.1.jpg?nolink  |}} {{  :postgres:boto-nlp:figura_8.1.jpg?nolink  |}}
-<html><center> Figura 8.1: Exemplo de request para a rota /gsan/segundaViaContaRelatorio com e-mail</center></html>+<html><center> Figura 9.1: Exemplo de request para a rota /gsan/segundaViaContaRelatorio com e-mail</center></html>
 </WRAP> </WRAP>
 \\ \\
Linha 250: Linha 277:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:figura_8.2.jpg?nolink  |}} {{  :postgres:boto-nlp:figura_8.2.jpg?nolink  |}}
-<html><center> Figura 8.2: Exemplo de request para a rota /gsan/segundaViaContaRelatorio sem e-mail</center></html>+<html><center> Figura 9.2: Exemplo de request para a rota /gsan/segundaViaContaRelatorio sem e-mail</center></html>
 </WRAP> </WRAP>
 \\ \\
Linha 257: Linha 284:
 ===== Abrir RA: Falta D’Água, Vazamento e Religação ===== ===== Abrir RA: Falta D’Água, Vazamento e Religação =====
 <columns> <columns>
-**A.P.I’s** responsáveis pela verificação e cadastramento de registros de atendimento (RA) por Falta de Água, Vazamento e Religação da ligação de água. Veja abaixo as rotas necessárias para a realização deste serviço:+**A.P.I’s** responsáveis pela verificação e cadastramento de Registros de Atendimento por Falta de Água, Vazamento e Religação da ligação de água. Segue abaixo as rotas **REST** para realização do fluxo:
 </columns> </columns>
  
Linha 282: Linha 309:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:figura_9.jpg?nolink  |}} {{  :postgres:boto-nlp:figura_9.jpg?nolink  |}}
-<html><center> Figura 9.1: Exemplo de request para a rota /gsan/verficarRAWS com RA pendente</center></html>+<html><center> Figura 10.1: Exemplo de request para a rota /gsan/verficarRAWS com RA pendente</center></html>
 </WRAP> </WRAP>
 <columns> <columns>
Linha 295: Linha 322:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:9.2.jpg?nolink  |}} {{  :postgres:boto-nlp:9.2.jpg?nolink  |}}
-<html><center> Figura 9.2: Exemplo de request para a rota /gsan/verficarRAWS sem RA pendente</center></html>+<html><center> Figura 10.2: Exemplo de request para a rota /gsan/verficarRAWS sem RA pendente</center></html>
 </WRAP> </WRAP>
 \\ \\
  
 <columns> <columns>
-**Observação**: No exemplo **9.2** o código de status da resposta é **422**.+**Observação**: No exemplo **10.2** o código de status da resposta é **422**.
 </columns> </columns>
  
Linha 326: Linha 353:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:kaufman2.jpg?nolink  |}} {{  :postgres:boto-nlp:kaufman2.jpg?nolink  |}}
-<html><center> Figura 10: Exemplo de request para a rota /gsan/episodiosFaltaAgua</center></html>+<html><center> Figura 11: Exemplo de request para a rota /gsan/episodiosFaltaAgua</center></html>
 </WRAP> </WRAP>
  
Linha 349: Linha 376:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:kaufman3.jpg?nolink  |}} {{  :postgres:boto-nlp:kaufman3.jpg?nolink  |}}
-<html><center> Figura 11: Exemplo de request para a rota /gsan/tipoEspecificacaoRA</center></html>+<html><center> Figura 12: Exemplo de request para a rota /gsan/tipoEspecificacaoRA</center></html>
 </WRAP> </WRAP>
 +\\
 ==== POST /gsan/verificarExistenciaRAReligacao ==== ==== POST /gsan/verificarExistenciaRAReligacao ====
 <columns> <columns>
Linha 371: Linha 398:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:kaufman5.jpg?nolink  |}} {{  :postgres:boto-nlp:kaufman5.jpg?nolink  |}}
-<html><center> Figura 12.1 – Exemplo de request para a rota /gsan/verificarExistenciaRAReligacao</center></html>+<html><center> Figura 13.1 – Exemplo de request para a rota /gsan/verificarExistenciaRAReligacao</center></html>
 </WRAP> </WRAP>
 \\ \\
Linha 384: Linha 411:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:kaufman13.jpg?nolink  |}} {{  :postgres:boto-nlp:kaufman13.jpg?nolink  |}}
-<html><center> Figura 12.2 – Exemplo 2 de request para a rota /gsan/verificarExistenciaRAReligacao</center></html>+<html><center> Figura 13.2 – Exemplo 2 de request para a rota /gsan/verificarExistenciaRAReligacao</center></html>
 </WRAP> </WRAP>
 \\ \\
  
 <columns> <columns>
-**Observação**: No exemplo **12.2** o código de status da resposta é **422**.+**Observação**: No exemplo **13.2** o código de status da resposta é **422**.
 </columns> </columns>
  
Linha 427: Linha 454:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:13.1.jpg?nolink  |}} {{  :postgres:boto-nlp:13.1.jpg?nolink  |}}
-<html><center> Figura 13.1 – Exemplo de request para a rota /gsan/verificarDebitosImovel</center></html>+<html><center> Figura 14.1 – Exemplo de request para a rota /gsan/verificarDebitosImovel</center></html>
 </WRAP> </WRAP>
 \\ \\
Linha 438: Linha 465:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:13.2.jpg?nolink  |}} {{  :postgres:boto-nlp:13.2.jpg?nolink  |}}
-<html><center> Figura 13.2 – Exemplo 2 de request para a rota /gsan/verificarDebitosImovel</center></html>+<html><center> Figura 14.2 – Exemplo 2 de request para a rota /gsan/verificarDebitosImovel</center></html>
 </WRAP> </WRAP>
  
Linha 460: Linha 487:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:14.jpg?nolink  |}} {{  :postgres:boto-nlp:14.jpg?nolink  |}}
-<html><center> Figura 14 – Exemplo 2 de request para a rota /gsan/verificarEmailCadastrado</center></html>+<html><center> Figura 15 – Exemplo 2 de request para a rota /gsan/verificarEmailCadastrado</center></html>
 </WRAP> </WRAP>
 \\ \\
Linha 493: Linha 520:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:15.jpg?nolink  |}} {{  :postgres:boto-nlp:15.jpg?nolink  |}}
-<html><center> Figura 15 – Exemplo de request para a rota /gsan/inserirRAWS</html>+<html><center> Figura 16 – Exemplo de request para a rota /gsan/inserirRAWS</html>
 </WRAP> </WRAP>
 \\ \\
Linha 524: Linha 551:
 <WRAP center round box 100%> <WRAP center round box 100%>
 {{  :postgres:boto-nlp:16.jpg?nolink  |}} {{  :postgres:boto-nlp:16.jpg?nolink  |}}
-<html><center> Figura 16 – Exemplo de request para a rota /gsan/inserirRAReligacao</html>+<html><center> Figura 17 – Exemplo de request para a rota /gsan/inserirRAReligacao</html>
 </WRAP> </WRAP>
  
Linha 530: Linha 557:
  
 \\ \\
 +Clique **[[=postgres:tatodesk|AQUI]]** para retornar.
 ~~NOSIDEBAR~~ ~~NOSIDEBAR~~
 +\\
 ~~ODT~~ ~~ODT~~
postgres/boto-nlp/api.1659453383.txt.gz · Última modificação: 02/08/2022 15:16 (edição externa)