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 Dados Clientes ======

<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.
  - value, //String// contendo o CPF/CNPJ do cliente que se pretende pesquisar.
</columns>
\\

===== Exemplo de Requisição para o Sistema =====

Com as seguintes informações:
|IP|192.168.64.111|
|Chave de autenticação|aBC123DEF|
|CPF|733.328.638-22|


\\

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

http://192.168.64.111:8080/gsan/dadosCadastraisCliente?key=aBC123DEF&value=73332863822

\\

===== Retorno em Caso de Sucesso =====
<code javascript>

{
  "key": (String) chave de autenticação recebida pelo WebService,
  "qtd": (Integer) quantidade de registros retornados,
  "resultado": [
    {
      "a": (Integer) Id do Cliente,
      "b": (String) nome do cliente,
      "c": (String) tipo da Pessoa (Fisica ou Juridica),
      "d": (String) CPF formatado,
      "e": (String) Tipo do endereço,
      "f": (String) Endereço do Cliente,
      "g": (String) Número do RG,
      "h": (String) Data de Nascimento,
      "i": (String) Número da Inscrição Estadual,
      "j": (String) Razão Social,
      "k": Lista de Objetos contendo os campos do telefone: 
      [
        "ddd": (Inteiro) DDD do Telefone,
        "numero": (String) Número do Telefone
      ]
    }
  ]
}
</code>
\\

**Exemplo**:

<code javascript>
	{
  "key": "APPAG9G8F7GF",
  "qtd": 1,
  "resultado": {
    "a": 5555,
    "b": "MANYR ABUD",
    "c": "FÍSICA",
    "d": "123.123.123-12",
    "e": "RESIDENCIAL",
    "f": "RUA 30 CJ COHAJU - 37 JABOTIANA ARACAJU SE 80520-080",
    "g": "73216",
    "h": "22/04/1500",
    "i": "12124545",
    "j": "MANYR ABUD",
    "k": [
      {
        "ddd": "79",
        "numero": "30430529"
      },
      {
        "ddd": "79",
        "numero": "02246302"
      },
      {
        "ddd": "79",
        "numero": "32472654"
      }
    ],
  }
}
</code>

\\

===== 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:dados_cliente_json_2.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.