Contas

Criação

Cadastro do Usuário.

Pessoa Física

Chamada:

POST https://[ambiente].loggi.com/api/v1/usuarios/pf/criar/

Payload:

{
    "user":
    {
        "first_name": "Juarez Rodolfo ",
        "last_name": "Machado Andrade Guimarães",
        "mobile_1": "1132323232",
        "toc": "on",
        "password_1": "1234",
        "password_2": "1234",
        "email": "a@example.com",
        "cpf": "235.616.614-91"
    }
}

Headers Sucesso:

HTTP 201

Payload Sucesso:

{
    "status": null,
    "first_name": "Juarez Rodolfo ",
    "last_name": "Machado Andrade Guimarães",
    "account_type": "PersonalCustomer",
    "mobile_2": null,
    "mobile_1": "1132323232",
    "created": 1394639841,
    "company": null,
    "cpf": "235.616.614-91",
    "id": 29,
    "full_name": "Juarez Rodolfo  Machado Andrade Guimarães",
    "is_company_admin": false,
    "email": "a@example.com",
    "resource_uri": "/api/v1/usuarios/29/"
}

Edição

Para editar um cadastro.

Pessoa Física

No exemplo abaixo, o email foi mudado. O payload segue a mesma estrutura da criação (exceto pelo password), podendo ser enviado também apenas o item mudado.

Chamada:

PATCH https://[ambiente].loggi.com/api/v1/usuarios/[id]/

Payload:

{
    "user":
    {
        "first_name": "Juarez Rodolfo",
        "last_name": "Machado Andrade Guimarães",
        "mobile_1": "1132323232",
        "toc": "on",
        "email": "juarez@example.com",
        "cpf": "235.616.614-91"
    }
}

Headers Sucesso:

HTTP 202

Payload Sucesso:

{
    "status": null,
    "first_name": "Juarez Rodolfo",
    "last_name": "Machado Andrade Guimarães",
    "account_type": "PersonalCustomer",
    "mobile_2": null,
    "mobile_1": "1132323232",
    "created": 1394639841,
    "company": null,
    "cpf": "235.616.614-91",
    "id": 29,
    "full_name": "Juarez Rodolfo  Machado Andrade Guimarães",
    "is_company_admin": false,
    "email": "juarez@example.com",
    "resource_uri": "/api/v1/usuarios/29/"
}

Login

Para efetuar o Login, a chamada deve ser executada conforme as seguintes instruções:

Request:

POST https://[ambiente].loggi.com/api/v1/usuarios/login/

Payload:

{"user": {"password": "1234", "email": "user-1@example.com"}}

Headers Sucesso:

HTTP 202

Payload Sucesso:

{
    "success": true,
    "redirect_to": "/api/v1/usuarios/1/",
    "api_key": "3432jfds343"
}

O redirect_to traz mais detalhes sobre o usuário:

{
    "api_key": "3432jfds343",
    "status": null,
    "first_name": "João",
    "last_name": "Da Silva Guimarães",
    "account_type": "PersonalCustomer",
    "mobile_2": null,
    "mobile_1": "11993-3433",
    "created": 1394564797,
    "company": null,
    "cpf": "123.126.325-35",
    "id": 1,
    "full_name": "João Da Silva Guimarães",
    "is_company_admin": false,
    "email": "user-1@example.com",
    "resource_uri": "/api/v1/usuarios/1/"
}

Header Falha:

HTTP 401

Payload Falha:

{
    "errors":
    {
        "email": "Email e senha não encontrados"
    },
    "success": false
}

Logout

Para efetuar o Logout, deve-se apenas enviar a requisição a seguir.

Request:

POST https://[ambiente].loggi.com/api/v1/usuarios/logout/

Header Sucesso:

HTTP 202

Payload Sucesso:

{
    "success": true
}