Introdução

Esta api consulta em nossa base de dados, o status do cliente (Ativo, Em Carencia, Suspenso, Cancelado) e retorna para o usuário informações como, 'inscricao', 'nome do titular', 'status do cliente', 'descricao do status', 'erro ocorrido', 'tipo de erro'.

Review

Metodo Get - A principio está api so utiliza um metodo, conhecido como GET.

Status - O campo status retorna o código de status do cliente, podendo ser (1,2,3,4).

Codigos do status:

1 - Ativo

2 - Suspenso

3 - Cancelado

4 - Em Carencia

Consumindo a API

Para utilizar a API, será necessário um valor de usuário, que será enviado para você por alguem da equipe de desenvolvimento do Grupo Zelo.

Após isso, utilize a url abaixo para fazer a requisição ao nosso banco.

METODO GET - BUSCA POR INSCRIÇÃO

URL: https://apizelo.grupozelo.com/index.php/cliente/{valor do usuário}/inscricao/{valor da inscricao}

Troque o valor de usuário, pelo usuário definido a você pela equipe de desenvolvimento do grupo zelo.

Troque o valor de inscricao, pelo número de inscrição do titular, este número pode ser encontrado no cartão de beneficios ducash do mesmo.


Exemplo:

https://apizelo.grupozelo.com/index.php/cliente/teste/inscricao/88032223

A respota a está consulta vem em formato de JSON como mostra o exemplo abaixo.

Resposta:

{ "Cliente":

  {

    "inscricao": "88032223",

    "nome": "MARIA DA GLORIA CARVALHO GUERRA",

    "status": "1",

    "descricao": "ATIVO",

    "respost": "0",

    "erro": "null"

  }

}

METODO GET - BUSCA POR CPF

URL: https://apizelo.grupozelo.com/index.php/cliente/{valor do usuário}/cpf/{valor do cpf}

Troque o valor de usuário, pelo usuário definido a você pela equipe de desenvolvimento do grupo zelo.

Troque o valor de inscricao, pelo número de cpf do titular.


Exemplo:

https://apizelo.grupozelo.com/index.php/cliente/teste/cpf/99900099900

A respota a está consulta vem em formato de JSON como mostra o exemplo abaixo.

Resposta:

{ "Cliente":

  {

    "inscricao": "88032223",

    "nome": "MARIA DA GLORIA CARVALHO GUERRA",

    "status": "1",

    "descricao": "ATIVO",

    "respost": "0",

    "erro": "null"

  }

}

Possiveis Erros

Os erros, relacionados a API, vem em dois paramentros, "respost" e "erro", no campo "respost" se encontra o codigo do erro, enquanto no campo "erro", se encontra a descrição do mesmo.

Os codigos podem ser:

0 - Nenhum erro encontrado.

1 - Usuário invalido.

2 - Cliente não encontrado.

3 - Servidor em manutenção.

4 - Erro interno no servidor.

5 - Página não encontrado.

Limite de Requisiçoes

Não existem limites para o número de pedidos a API.

Duvidas e Sugestões

Para tirar duvidas, deixar sugestões ou solicitar um novo processo, entre em contato com a equipe de desenvolvimento

Email: sistemas@grupozelo.com

Telefone: (31)3314-8000