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-validar-chave-termo-parcelamento

WebService Validar Chave do Termo de Parcelamento

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

Ele espera os seguintes Parâmetros:

  1. key, String contendo a chave de autenticação da empresa.
  2. matricula, Integer contendo a matrícula do imóvel.
  3. chave, String contendo a chave de identificação do termo de parcelamento


Exemplo de requisição para o sistema

Com as seguintes informações:

IP192.168.64.111
keyjjFsdi45iHDYHdt78dJT-EH
matricula2021
chave2HTBEULYKXH


A Requisição Seria

Envio - JSON

{
    "key": "jjFsdi45iHDYHdt78dJT-EH",
    "matricula": 10045,
    "chave": "2HTBEULYKXH"
}


Retorno com Sucesso - JSON

{
    "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"
    }
}


Retorno com Insucesso - JSON

{
    "key": "jjFsdi45iHDYHdt78dJT-EH",
    "error": {
        "parametrosMensagem": [],
        "detailMessage": "atencao.nao_existe_parcelamento_simulado"
    },
    "message": "atencao.nao_existe_parcelamento_simulado"
}


Possíveis Códigos de Retorno

CódigoMensagem
200“OK”
500“Internal Server Error”
404“Page not found”


Clique AQUI para acessar outros serviços com os detalhes técnicos das integrações.

integracoes/web-services-validar-chave-termo-parcelamento.txt · Última modificação: 30/08/2023 17:49 por hiroshi.goncalves