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: • web-services-gerar-cnd

Barra lateral

integracoes:web-services-gerar-cnd

Tabela de conteúdos

WebService Gerar Certidão Negativa

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:

  1. key, String contendo a chave de autenticação da empresa.
  2. matricula, String parâmetro opcional, contendo a matrícula do imóvel que se pretende pesquisar.
  3. email, String parâmetro opcional; caso seja informado o sistema envia a certidão para o e-mail informado.
  4. cpfCnpf, String parâmetro opcional, contendo o cpf ou cnpj do cliente que se pretende pesquisar.
  5. É obrigatorio informar matrícula ou cpf/cnpj.


Exemplo de Requisição para o Sistema

Com as seguintes informações:

IP192.168.64.111
Chave de autenticaçãoaBC123DEF
Matrícula5136024
E-mail teste@teste.com
cpfCnpj 12345678985


A Requisição Seria

certidão do imóvel http://192.168.64.111:8080/gsan/certidaoNegativaDebitos?key=aBC123DEF&matricula=5136024&email=teste@teste.com

ou

certidão do cliente http://192.168.64.111:8080/gsan/certidaoNegativaDebitos?key=aBC123DEF&cpfCnpj=15685212345&email=teste@teste.com


Retorno em Caso de Sucesso

Download do arquivo PDF


Retorno em Caso de Erro

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

Exemplo:


Possíveis Códigos de Retorno

CódigoMensagem
400“parâmetros inválidos”
401“chave inválida”
404“A consulta não trouxe resultados”
500“”


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

integracoes/web-services-gerar-cnd.txt · Última modificação: 14/07/2023 14:10 por vivianne.sousa

Ferramentas da página

Exceto onde for informado ao contrário, o conteúdo neste wiki está sob a seguinte licença: CC Attribution-Noncommercial 4.0 International
CC Attribution-Noncommercial 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki