Skip to content
Reginaldo Junior edited this page Jul 30, 2016 · 17 revisions

Neste documento você vai encontrar a explicação de como consumir a API de cliente.

Primeiro de tudo é o endpoint, nosso endpoint padrão é este.

http://www.ciawn.com.br/api/client

Para autenticação do seu usuário você deve passar o seu email e senha como parâmetro get na url.

Exemplo

http://www.ciawn.com.br/api/client/?token=seutoken

Recuperando os dados de um cliente (GET)

http://www.ciawn.com.br/api/client/{id_do_cliente}/?token=seutoken

Resposta: JSON com os dados do cliente passado na url

Recuperando todos os clientes (GET)

http://www.ciawn.com.br/api/client/?token=seutoken

Resposta: JSON com todos os clientes cadastrados na sua conta

Recuperando cliente pelo e-mail e senha (POST)

http://www.ciawn.com.br/api/client/?token=seutoken

Parâmetros

  • email *
  • senha *

Resposta: JSON com o resultado true ou false;

Adicionando novos clientes (POST)

http://www.ciawn.com.br/api/client/?token=seutoken

Parâmetros

  • nome1 *
  • nome2 *
  • email *
  • documento1
  • documento2
  • senha
  • data_de_nascimento, formato (YYYY-MM-DD)

Resposta: JSON com os dados inseridos.

Editando clientes (PUT)

http://www.ciawn.com.br/api/client/{id_cliente}/?token=seutoken

Parâmetros

  • nome1
  • nome2
  • email
  • documento1
  • documento2
  • senha
  • data_de_nascimento, formato (YYYY-MM-DD)

Resposta: JSON com os dados atualizados.

Removendo clientes (DELETE)

http://www.ciawn.com.br/api/client/{id_cliente}/?token=seutoken

Resposta: JSON com o resultado da operação.