Skip to content

Profiles

Jump to bottom
Ronaldo Meneguite edited this page Jul 4, 2018 · 3 revisions

GET /v1/profile - Retorna os detalhes do usuário logado

Parâmetros

[
  {
    "name": "Authorization",
    "in": "header",
    "type": "string",
    "required": true,
    "description": "Token válido",
    "example": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0L3YxL2F1dGgvMmZhIiwiaWF0IjoxNTIyMTY4NTM0LCJleHAiOjE1NTgxNjg1MzQsIm5iZiI6MTUyMjE2ODUzNCwianRpIjoiY0ZSaHRGV2VXN0hZTGVyTiIsI"
  }
]

Respostas

HTTP 200 - Detalhes do usuário logado

{
  "hash": "jqozmk",
  "name": "Administrator",
  "email": "user@email.com",
  "key": "196e1ed3-708f-3249-88c3-123231211",
  "document": "37424012118",
  "document_secondary": "12312312312",
  "phone": "(32) 98888-8888",
  "phone_secondary": "(32) 98888-8889",
  "birth": "1988-01-02",
  "mother": "Andrea Carmona Lutero Neto",
  "addresses": [
    {
      "city": "Nome da Cidade",
      "number": "10",
      "address": "Nome da Rua",
      "country": "Brasil",
      "district": "Bairro",
      "zip_code": "36770-000",
      "complement": null
    }
  ],
  "ip_register": "127.0.0.1",
  "language": "pt-br",
  "comments": "Teste",
  "status": "OK",
  "a2fa": false,
  "verified_at": null
}

HTTP 401 - Acesso não autorizado

{
  "message":"Unauthorized"
}

HTTP 429 - Excedido o número de tentativas de acesso

{
  "message":"Exceeded the limit of attempts. Wait for 5 minutes for another try."
}

POST /v1/profile - Atualiza o usuário logado

Parâmetros

[
  {
    "name": "Authorization",
    "in": "header",
    "type": "string",
    "required": true,
    "example": "Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "description": "Token válido"
  },
  {
    "name": "name",
    "in": "formData",
    "type": "string",
    "required": true,
    "description": "Nome do usuário"
  },
  {
    "name": "email",
    "in": "formData",
    "type": "email",
    "required": true,
    "description": "E-mail válido para o usuário"
  },
  {
    "name": "document",
    "in": "formData",
    "type": "string",
    "required": true,
    "description": "Documento válido (CPF ou CNPJ)"
  },
  {
    "name": "document_secondary",
    "in": "formData",
    "type": "string",
    "required": false,
    "description": "Documento secundário válido (RG ou IE)"
  },
  {
    "name": "phone",
    "in": "formData",
    "type": "string",
    "required": false,
    "description": "Telefone Primário",
    "example": "(32) 98888-8888"
  },
  {
    "name": "phone_secondary",
    "in": "formData",
    "type": "string",
    "required": false,
    "description": "Telefone Secundário",
    "example": "(32) 98888-8888"
  },
  {
    "name": "birth",
    "in": "formData",
    "type": "date",
    "required": false,
    "description": "Data de nascimento",
    "example": "1988-01-20"
  },
  {
      "name": "mother",
      "in": "formData",
      "type": "string",
      "required": false,
      "description": "Nome completo da mãe",
      "example": "Isabella Corona Santiago"
    },
  {
    "name": "language",
    "in": "formData",
    "type": "list",
    "accepted": ["pt-br", "en"],
    "required": false,
    "description": "Idioma do usuário",
    "comments": "Quando não é definido um valor é setado para o campo o idioma padrão do sistema"
  },
  {
    "name": "comments",
    "in": "formData",
    "type": "string",
    "required": false,
    "description": "Breve comentário sobre o usuário"
  },
  {
    "name": "addresses",
    "in": "formData",
    "type": "json",
    "required": false,
    "description": "Endereços do usuário",
    "definition": [
      {
        "name": "zip_code",
        "type": "string",
        "required": true,
        "description": "Código Postal",
        "example": "36700-000"
      },
      {
        "name": "address",
        "type": "string",
        "required": true,
        "description": "Endereço",
        "example": "Avenida Amazonas"
      },
      {
        "name": "number",
        "type": "string",
        "required": true,
        "example": "10"
      },
      {
        "name": "district",
        "type": "string",
        "required": true,
        "example": "Centro"
      },
      {
        "name": "complement",
        "type": "string",
        "required": false,
        "example": "Apt 10"
      },
      {
        "name": "city",
        "type": "string",
        "required": true,
        "example": "São Paulo"
      },
      {
        "name": "country",
        "type": "string",
        "required": true,
        "example": "Brasil"
      }
    ]
  }
]

Exemplo de Envio:

{
  "name": "Administrator",
  "email": "admin@email.com",
  "document": "40059173726",
  "document_secondary": "12312312312",
  "phone": "(32) 98888-8888",
  "phone_secondary": "(32) 98888-8889",
  "birth": "1988-01-20",
  "mother": "Isabella Corona Santiago",
  "addresses": [
    {
      "zip_code": "36770-000",
      "address": "Nome da Rua",
      "number": "10",
      "district": "Bairro",
      "complement": "Apt 10",
      "city": "Nome da Cidade",
      "country": "Brasil"
    }
  ],
  "language": "pt-br",
  "comments": "Teste"
}

Respostas

HTTP 200 - Detalhes do usuário logado

{
  "hash": "jqozmk",
  "name": "Administrator",
  "email": "ronaldo@email.com",
  "key": "196e1ed3-708f-3249-88c3-5b219ac95618",
  "document": "07261278688",
  "document_secondary": "12312312312",
  "phone": "(32) 98888-8888",
  "phone_secondary": "(32) 98888-8889",
  "birth": "1988-01-20",
  "mother": "Isabella Corona Santiago",
  "addresses": [
    {
      "city": "Nome da Cidade",
      "number": "10",
      "address": "Nome da Rua",
      "country": "Brasil",
      "district": "Bairro",
      "zip_code": "36770-000",
      "complement": null
    }
  ],
  "ip_register": "127.0.0.1",
  "language": "pt-br",
  "comments": "Teste",
  "status": "NEW",
  "a2fa": false,
  "verified_at": null
}

HTTP 401 - Acesso não autorizado

{
  "message":"Unauthorized"
}

HTTP 429 - Excedido o número de tentativas de acesso

{
  "message":"Exceeded the limit of attempts. Wait for 5 minutes for another try."
}

Clone this wiki locally