Base de Conhecimento de Gestão Comercial de Saneamento

Essa página está em modo somente de leitura. Você pode visualizar a fonte, mas não alterá-la. Informe-se com o administrador do Wiki, caso você ache que isso está incorreto.

{{ajuda:logo-gsan3.png?90|}}


====== WebService Validar Chave do Termo de Parcelamento ======

<columns>
O WebService recebe apenas requisições do tipo **POST**, e os parâmetros são passados via **JSON**.

Ele espera os seguintes Parâmetros:
  - key, //String// contendo a chave de autenticação da empresa.
  - matricula, //Integer// contendo a matrícula do imóvel.
  - chave, //String// contendo a chave de identificação do termo de parcelamento
</columns>
\\

===== Exemplo de requisição para o sistema =====

Com as seguintes informações:
|IP|192.168.64.111|
|key|jjFsdi45iHDYHdt78dJT-EH|
|matricula|2021|
|chave|2HTBEULYKXH|
\\

===== A Requisição Seria =====

http://192.168.64.111:8080/gsan/validarChaveTermoParcelamento

===== Envio - JSON  ===== 

<code javascript>
{
    "key": "jjFsdi45iHDYHdt78dJT-EH",
    "matricula": 10045,
    "chave": "2HTBEULYKXH"
}
</code>
\\

===== Retorno com Sucesso - JSON =====

<code javascript>
{
    "key": "jjFsdi45iHDYHdt78dJT-EH",
    "body": {
        "idParcelamento": "72653",
        "dataParcelamento": "10/07/2023",
        "valorParcelamento": "76,82",
        "valorEntrada": "5,00",
        "qtdeParcelas": "3",
        "valorParcelas": "23,94",
        "qtdeParcelasSucumbencia": "3",
        "valorParcelasSucumbencia": "250,00"
    }
}
</code>
\\

===== Retorno com Insucesso - JSON ===== 
<code javascript>
{
    "key": "jjFsdi45iHDYHdt78dJT-EH",
    "error": {
        "parametrosMensagem": [],
        "detailMessage": "atencao.nao_existe_parcelamento_simulado"
    },
    "message": "atencao.nao_existe_parcelamento_simulado"
}
</code>
\\

===== Possíveis Códigos de Retorno =====
|Código|Mensagem|Body
|200|"OK"|
|500|"Internal Server Error"|
|404|"Page not found"|
\\

Clique **[[=integracoes:web-services|AQUI]]** para acessar outros serviços com os detalhes técnicos das integrações.