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-enviar-confirmar-parcelamento

WebService Confirmar 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. idImovel, Integer contendo o identificador do imovel
  3. cdConfirmacao, String contendo o código de confirmação do parcelamento recebido por email
  4. confirmacao, String contendo 1 para realizar o parcelamento ou 2 para não realizar o parcelamento.


Exemplo de requisição para o sistema

Com as seguintes informações:

IP192.168.64.111
keyjjFsdi45iHDYHdt78dJT-EH
idImovel2021
cdConfirmacaoBYO3V8H9C5A
confirmacao1


A Requisição Seria

Envio - JSON

{
    "key": "jjFsdi45iHDYHdt78dJT-EH",
    "idImovel":"2021",
    "cdConfirmacao": "BYO3V8H9C5A",
    "confirmacao": "1"
 }


Retorno com Sucesso - JSON

{
    "key": "jjFsdi45iHDYHdt78dJT-EH",
    "body": {
        "idParcelamento": "123",
        "idRegistroAtendimento": "456",
        "chaveTermo": "AAF42GD8GFF",
        "email": "teste@teste.com"
    }
}


Retorno com Insucesso - JSON

{
    "key": "jjFsdi45iHDYHdt78dJT-EH",
    "error": {
        "detailMessage": "erro.sistema",
        "cause": {
            "parametrosMensagem": [],
            "detailMessage": "atencao.parcelamento_fora_prazo_confirmacao"
        }
    },
    "message": "erro.sistema"
}


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-enviar-confirmar-parcelamento.txt · Última modificação: 31/08/2023 12:35 por hiroshi.goncalves