Clientes

Através da rota /clientes, você poderá listar, consultar, criar e atualizar clientes.


- Listando Clientes

O endereço abaixo pode ser utilizado para listar todos os clientes com paginação, retornando até 500 clientes por requisição.


GET 

/clientes
{
    "total": 1,
    "per_page": 500,
    "current_page": 1,
    "last_page": 1,
    "next_page_url": null,
    "prev_page_url": null,
    "from": 1,
    "to": 1,
    "last_page_url": "https://ev.kapsula.com.br/api/v1/clientes?page=1",
    "first_page_url": "https://ev.kapsula.com.br/api/v1/clientes?page=1",
    "path": "https://ev.kapsula.com.br/api/v1/clientes",
    "data": [
        {
            "id": 32434244,
            "sexo": null,
            "cpf": "xxxxxxxxxxx",
            "nome": "xxxx xxxxxxxxxx xxxxxxx",
            "data_nascimento": null,
            "email": "xxxx@xxxxxx.com",
            "endereco": "xxxx xxxxxx xxx xxxxxx",
            "numero": "xxx",
            "complemento": "apto 401",
            "bairro": "xxxxxxx xxxxxxx",
            "cidade": "Vila Velha",
            "estado": "ES",
            "pais": "Brasil",
            "cep": "xxxxxxxxx",
            "telefone": "xx xxxxxxxxx",
            "celular": "",
            "referencia_externa": null,
            "created_at": "2017-07-29 12:34:49",
            "updated_at": "2017-07-29 12:34:49"
        }
    ]
}


- Obtendo um Cliente

Você também tem a possibilidade de recuperar um determinado cliente, a rota é a mesma, a única diferença é que será necessário acrescentar o ID do cliente no final da rota: /clientes/ID.

 GET 


/clientes/ID
{
    "code" :200,
    "cliente": {
        "id": 32434244,
        "sexo": null,
        "cpf": "xxxxxxxxxxx",
        "nome": "xxxx xxxxxxxxxx xxxxxxx",
        "data_nascimento": null,
        "email": "xxxx@xxxxxx.com",
        "endereco": "xxxx xxxxxx xxx xxxxxx",
        "numero": "xxx",
        "complemento": "apto 401",
        "bairro": "xxxxxxx xxxxxxx",
        "cidade": "Vila Velha",
        "estado": "ES",
        "pais": "Brasil",
        "cep": "xxxxxxxxx",
        "telefone": "xx xxxxxxxxx",
        "celular": "",
        "referencia_externa": null,
        "created_at": "2017-07-29 12:34:49",
        "updated_at": "2017-07-29 12:34:49"
    }
}

- Registrando Clientes

Para a criação de clientes utilize a rota /clientes com o método POST. Segue exemplo de dados enviados e descrição dos Campos:

POST

/clientes
{
    "cpf"               : "76341168314",   // Required
    "nome"              : "Novo Cliente",   // Required
    "data_nascimento"   : "19/07/1995",   // Opcional | Data válida no mesmo formato
    "email"             : "email@email.com", // Required | Email Válido
    "telefone"          : "63985931817",   // Required
    "sexo"              : "M",      // Opcional
    "cep"               : "77001136",    // Required
    "endereco"          : "Rua do Cliente",  // Required
    "numero"            : "244",     // Required
    "bairro"            : "Centro",    // Required
    "cidade"            : "Palmas",    // Required
    "estado"            : "TO",     // Required
    "pais"              : "Brasil",    // Required
    "complemento"       : "",      // Opcional
    "referencia_externa": "",      // Opcional
}


Se tudo estiver correto, o retorno será uma mensagem de sucesso com o ID do novo cliente. 


{
    "code" : 200,
    "message" : "Cliente cadastrado com sucesso",
    "cliente" : 1115820
}


Atualizando Clientes

Para atualizar um cliente, basta utilizar a rota /clientes/ID com o método PUT enviando os dados que deseja atualizar. Os campos continuam sendo os mesmos utilizados para criar um cliente, porém todos opcionais, mas caso informados precisam conter valores válidos.

PUT 
/clientes/ID
{
    "cpf"               : "76341168314",      // Opcional
    "nome"              : "Nome Atualizado",    // Opcional
    "data_nascimento"   : "19/07/1995",      // Opcional | Data válida no mesmo formato
    "email"             : "email@email.com",    // Opcional | Email Válido
    "telefone"          : "63985931817",      // Opcional
    "sexo"              : "M",         // Opcional
    "cep"               : "77001136",       // Opcional
    "endereco"          : "Nova Rua do Cliente",  // Opcional
    "numero"            : "244",        // Opcional
    "bairro"            : "Centro",       // Opcional
    "cidade"            : "Palmas",       // Opcional
    "estado"            : "TO",        // Opcional
    "pais"              : "Brasil",       // Opcional
    "complemento"       : "",         // Opcional
    "referencia_externa": "",         // Opcional
}


Se tudo estiver correto, o retorno será o cliente atualizado. 


{
    "code": 200,
    "cliente": {
        "id": 43341168353,
        "sexo": "M",
        "cpf": "77001136",
        "nome": "Nome Atualizado",
        "data_nascimento": "19/07/1995",
        "email": "email@email.com",
        "endereco": "Nova Rua do Cliente",
        "numero": "244",
        "complemento": "",
        "bairro": "Centro",
        "cidade": "Palmas",
        "estado": "TO",
        "pais": "Brasil",
        "cep": "83410380",
        "telefone": "63985931817",
        "celular": "",
        "referencia_externa": "",
        "created_at": "2017-04-26 17:42:41",
        "updated_at": "2019-05-09 17:28:41"
    }
}