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-dados-clientes

WebService Dados Clientes

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


Exemplo de Requisição para o Sistema

Com as seguintes informações:

IP192.168.64.111
Chave de autenticaçãoaBC123DEF
CPF733.328.638-22


A Requisição Seria

Retorno em Caso de Sucesso

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


Exemplo:

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


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-dados-clientes.txt · Última modificação: 06/10/2020 20:26 por hiroshi.goncalves