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


integracoes:web-services-segunda-via
no way to compare when less than two revisions

Diferenças

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


integracoes:web-services-segunda-via [12/12/2019 19:24] (atual) – criada tadeu.sarmento
Linha 1: Linha 1:
 +{{ajuda:logo-gsan3.png?90|}}
  
 +
 +====== WebService Emitir Segunda via de Conta ======
 +
 +<columns>
 +O WebService recebe apenas requisições do tipo **GET**, e os parâmetros são passados via **Query Parameter**.
 +
 +Ele espera os seguintes Parâmetros:
 +  - key, //String// contendo a chave de autenticação da empresa.
 +  - value, //String// contendo a matrícula do imóvel que pretende pesquisar.
 +  - //ref//, contendo a referência da conta a ser obtida.
 +</columns>
 +\\
 +
 +===== Exemplo de Requisição para o Sistema =====
 +Com as seguintes informações:
 +|IP|192.168.64.111|
 +|Chave de autenticação|aBC123DEF|
 +|Matrícula|5136024|
 +|Referência |201904|
 +
 +
 +\\
 +
 +===== A Requisição Seria =====
 +
 +http://192.168.64.111:8080/gsan/segundaViaContaImovel?key=aBC123DEF&value=5136024&ref=201904
 +
 +\\
 +
 +===== Retorno em Caso de Sucesso =====
 +**Download do arquivo PDF**
 +
 +\\
 +
 +===== Retorno em Caso de Erro =====
 +<code javascript>
 +{
 + "error": (Integer) Código de erro da requisição,
 + "msg": (String) Mensagem indicando o que houve, ou vazio em caso de erro 500,
 + "qtd": (Integer) sempre valor 0
 +}
 +
 +
 +</code>
 +
 +**Exemplo**:
 +\\
 +
 +<WRAP center round box 100%>
 +{{  :integracoes:emitir_segunda_via_json_1.jpg?nolink  |}}
 +</WRAP>
 +
 +\\
 +
 +===== Possíveis Códigos de Retorno =====
 +|Código|Mensagem|
 +|400|"parâmetros inválidos"|
 +|401|"chave inválida"|
 +|404|"A consulta não trouxe resultados"|
 +|500|“”|
 +\\
 +
 +Clique **[[=treinamentos:integracoes|AQUI]]** para acessar outros serviços com os detalhes técnicos das integrações.
integracoes/web-services-segunda-via.txt · Última modificação: 12/12/2019 19:24 por tadeu.sarmento