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 Gerar Certidão Negativa ======

<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.
  - matricula, //String// parâmetro opcional, contendo a matrícula do imóvel que se pretende pesquisar.
  - email, //String// parâmetro opcional; caso seja informado o sistema envia a certidão para o e-mail informado.
  - cpfCnpf, //String// parâmetro opcional, contendo o cpf ou cnpj do cliente que se pretende pesquisar. 
  - É obrigatorio informar matrícula ou cpf/cnpj.
</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|
|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 =====
<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:gerar_certidao_negativa_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.