API legada/Referência completa/Usuários (REST)

Endpoints de usuários

As URLs da API de Usuários: listar e criar usuários, e consultar, atualizar ou excluir um usuário pelo ID.

A API de Usuários tem duas URLs. /api/users trabalha com a coleção inteira (listar e criar). /api/users/{id} trabalha com uma conta (consultar, atualizar, excluir). As duas usam HTTP Basic com o e-mail:chave_de_api do administrador.

Listar usuários

Use esta chamada para obter as contas de usuário da loja. A resposta traz os usuários em data e as informações de paginação em meta. As senhas nunca são incluídas.

GET/api/usersAdmin

Retorna todas as contas de usuário

Parâmetros de consulta

pageintegerpadrão: 1

Página de usuários a retornar. As páginas começam em 1.

items_per_pageintegerpadrão: 10

Quantidade de usuários em cada página.

Exemplo de requisição

bash

curl "$BASE_URL/api/users?page=1&items_per_page=10" \
  -u "$EMAIL:$API_KEY"

Resposta

200Usuários retornados

json

{
  "data": [
    {
      "id": "user_001",
      "first_name": "João",
      "last_name": "Silva",
      "email": "joao.silva@example.com",
      "role": "admin",
      "active": true,
      "created_at": "2024-12-01T14:30:15Z",
      "last_login": "2025-04-10T09:22:45Z"
    },
    {
      "id": "user_002",
      "first_name": "Maria",
      "last_name": "Santos",
      "email": "maria.santos@example.com",
      "role": "customer",
      "active": true,
      "created_at": "2025-01-15T16:45:30Z",
      "last_login": "2025-04-12T18:33:20Z"
    }
  ],
  "meta": {
    "total": 124,
    "page": 1,
    "per_page": 10
  }
}

Criar um usuário

Envie os dados da conta como um objeto JSON. Os nomes dos campos e os campos obrigatórios estão em Campos de usuário.

POST/api/usersAdmin

Cria uma nova conta de usuário

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/users" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "first_name": "Ana",
  "last_name": "Oliveira",
  "email": "ana.oliveira@example.com",
  "password": "SecureP@ssw0rd",
  "role": "manager",
  "phone": "+5511987654321",
  "address": {
    "street": "Avenida Paulista, 1000",
    "city": "São Paulo",
    "state": "SP",
    "postal_code": "01310-100",
    "country": "Brazil"
  },
  "send_welcome_email": true
}'

Consultar um usuário

Retorna a conta com o ID informado.

GET/api/users/{id}Admin

Retorna um usuário específico

Parâmetros de caminho

idstringobrigatório

O identificador único do usuário.

Exemplo de requisição

bash

curl "$BASE_URL/api/users/user_001" \
  -u "$EMAIL:$API_KEY"

Atualizar um usuário

Envie só os campos que quer alterar. Os campos omitidos mantêm o valor atual.

PUT/api/users/{id}Admin

Atualiza um usuário específico

Parâmetros de caminho

idstringobrigatório

O identificador único do usuário.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/users/user_001" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "joao.silva.updated@example.com",
  "phone": "+5511999998888",
  "role": "super_admin",
  "address": {
    "street": "Rua Augusta, 500",
    "city": "São Paulo",
    "state": "SP",
    "postal_code": "01304-000",
    "country": "Brazil"
  }
}'

Excluir um usuário

Exclui a conta com o ID informado.

DELETE/api/users/{id}Admin

Exclui um usuário específico

Parâmetros de caminho

idstringobrigatório

O identificador único do usuário.

Exemplo de requisição

bash

curl -X DELETE "$BASE_URL/api/users/user_002" \
  -u "$EMAIL:$API_KEY"

Erros

Estes códigos de status valem para as chamadas em /api/users/{id}.

Status	Descrição
`200 OK`	Operação concluída com sucesso.
`400 Bad Request`	Parâmetros da requisição inválidos.
`403 Forbidden`	Permissões insuficientes para executar a operação.
`404 Not Found`	Não existe usuário com o ID informado.
`409 Conflict`	O endereço de e-mail já está em uso (na atualização).

Veja também

API legada/Referência completa/Usuários (REST)

Endpoints de usuários

As URLs da API de Usuários: listar e criar usuários, e consultar, atualizar ou excluir um usuário pelo ID.

Listar usuários

Use esta chamada para obter as contas de usuário da loja. A resposta traz os usuários em data e as informações de paginação em meta. As senhas nunca são incluídas.

GET/api/usersAdmin

Retorna todas as contas de usuário

Parâmetros de consulta

pageintegerpadrão: 1

Página de usuários a retornar. As páginas começam em 1.

items_per_pageintegerpadrão: 10

Quantidade de usuários em cada página.

Exemplo de requisição

bash

curl "$BASE_URL/api/users?page=1&items_per_page=10" \
  -u "$EMAIL:$API_KEY"

Resposta

200Usuários retornados

json

{
  "data": [
    {
      "id": "user_001",
      "first_name": "João",
      "last_name": "Silva",
      "email": "joao.silva@example.com",
      "role": "admin",
      "active": true,
      "created_at": "2024-12-01T14:30:15Z",
      "last_login": "2025-04-10T09:22:45Z"
    },
    {
      "id": "user_002",
      "first_name": "Maria",
      "last_name": "Santos",
      "email": "maria.santos@example.com",
      "role": "customer",
      "active": true,
      "created_at": "2025-01-15T16:45:30Z",
      "last_login": "2025-04-12T18:33:20Z"
    }
  ],
  "meta": {
    "total": 124,
    "page": 1,
    "per_page": 10
  }
}

Criar um usuário

Envie os dados da conta como um objeto JSON. Os nomes dos campos e os campos obrigatórios estão em Campos de usuário.

POST/api/usersAdmin

Cria uma nova conta de usuário

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/users" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "first_name": "Ana",
  "last_name": "Oliveira",
  "email": "ana.oliveira@example.com",
  "password": "SecureP@ssw0rd",
  "role": "manager",
  "phone": "+5511987654321",
  "address": {
    "street": "Avenida Paulista, 1000",
    "city": "São Paulo",
    "state": "SP",
    "postal_code": "01310-100",
    "country": "Brazil"
  },
  "send_welcome_email": true
}'

Consultar um usuário

Retorna a conta com o ID informado.

GET/api/users/{id}Admin

Retorna um usuário específico

Parâmetros de caminho

idstringobrigatório

O identificador único do usuário.

Exemplo de requisição

bash

curl "$BASE_URL/api/users/user_001" \
  -u "$EMAIL:$API_KEY"

Atualizar um usuário

Envie só os campos que quer alterar. Os campos omitidos mantêm o valor atual.

PUT/api/users/{id}Admin

Atualiza um usuário específico

Parâmetros de caminho

idstringobrigatório

O identificador único do usuário.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/users/user_001" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "joao.silva.updated@example.com",
  "phone": "+5511999998888",
  "role": "super_admin",
  "address": {
    "street": "Rua Augusta, 500",
    "city": "São Paulo",
    "state": "SP",
    "postal_code": "01304-000",
    "country": "Brazil"
  }
}'

Excluir um usuário

Exclui a conta com o ID informado.

DELETE/api/users/{id}Admin

Exclui um usuário específico

Parâmetros de caminho

idstringobrigatório

O identificador único do usuário.

Exemplo de requisição

bash

curl -X DELETE "$BASE_URL/api/users/user_002" \
  -u "$EMAIL:$API_KEY"

Erros

Estes códigos de status valem para as chamadas em /api/users/{id}.

Status	Descrição
`200 OK`	Operação concluída com sucesso.
`400 Bad Request`	Parâmetros da requisição inválidos.
`403 Forbidden`	Permissões insuficientes para executar a operação.
`404 Not Found`	Não existe usuário com o ID informado.
`409 Conflict`	O endereço de e-mail já está em uso (na atualização).