API legada/Referência completa/Grupos de usuários

Endpoints de grupos

As URLs da API de Usergroups: gerencie os grupos e a participação dos usuários neles.

Estes endpoints criam, consultam, atualizam e excluem grupos de usuários, e gerenciam quais usuários pertencem a eles. Todos usam HTTP Basic com o e-mail:chave_de_api do administrador.

Listar grupos de usuários

Retorna os grupos de usuários da loja, com as informações de paginação em meta.

GET/api/usergroupsAdmin

Retorna todos os grupos de usuários

Exemplo de requisição

bash

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

Resposta

200Grupos de usuários retornados

json

{
  "data": [
    {
      "id": 3,
      "name": "Administrators",
      "description": "Users with full system access",
      "member_count": 5,
      "permissions": [
        "manage_users",
        "manage_products",
        "manage_orders",
        "manage_settings"
      ],
      "created_at": "2024-12-01T10:00:00Z"
    },
    {
      "id": 4,
      "name": "Sales Team",
      "description": "Sales department staff",
      "member_count": 12,
      "permissions": [
        "view_customers",
        "manage_orders",
        "view_products"
      ],
      "created_at": "2024-12-15T14:30:00Z"
    }
  ],
  "meta": {
    "total": 5,
    "page": 1,
    "per_page": 10
  }
}

Criar um grupo de usuários

Cria um novo grupo. O exemplo abaixo mostra um corpo com o nome do grupo, a descrição, as permissões e os usuários a incluir.

POST/api/usergroupsAdmin

Cria um novo grupo de usuários

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/usergroups" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Support Team",
  "description": "Customer support representatives",
  "permissions": [
    "view_customers",
    "view_orders",
    "manage_tickets",
    "respond_tickets"
  ],
  "users": [
    "user_003",
    "user_007",
    "user_012"
  ]
}'

Consultar um grupo de usuários

Retorna um grupo pelo ID.

GET/api/usergroups/{id}Admin

Retorna um grupo de usuários específico

Parâmetros de caminho

idintegerobrigatório

O identificador único do grupo de usuários.

Exemplo de requisição

bash

curl "$BASE_URL/api/usergroups/4" \
  -u "$EMAIL:$API_KEY"

Atualizar um grupo de usuários

Altera o grupo com o ID informado.

PUT/api/usergroups/{id}Admin

Atualiza um grupo de usuários específico

Parâmetros de caminho

idintegerobrigatório

O identificador único do grupo de usuários.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/usergroups/4" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Sales and Marketing Team",
  "description": "Combined sales and marketing department",
  "permissions": [
    "view_customers",
    "manage_orders",
    "view_products",
    "manage_marketing"
  ]
}'

Excluir um grupo de usuários

Exclui o grupo com o ID informado.

DELETE/api/usergroups/{id}Admin

Exclui um grupo de usuários específico

Parâmetros de caminho

idintegerobrigatório

O identificador único do grupo de usuários.

Exemplo de requisição

bash

curl -X DELETE "$BASE_URL/api/usergroups/4" \
  -u "$EMAIL:$API_KEY"

Listar os grupos de um usuário

Retorna todos os grupos de usuários a que um usuário específico pertence.

GET/api/users/{id}/usergroupsAdmin

Retorna todos os grupos a que o usuário pertence

Parâmetros de caminho

idstringobrigatório

O identificador único do usuário.

Exemplo de requisição

bash

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

Resposta

200Grupos do usuário

json

{
  "data": [
    {
      "id": 2,
      "name": "Registered users",
      "description": "Default group for all registered users",
      "permissions": [
        "view_products",
        "place_orders"
      ]
    },
    {
      "id": 4,
      "name": "Sales Team",
      "description": "Sales department staff",
      "permissions": [
        "view_customers",
        "manage_orders",
        "view_products"
      ]
    }
  ]
}

Adicionar um usuário a um grupo

Adiciona o usuário ao grupo informado.

PUT/api/users/{user_id}/usergroups/{group_id}Admin

Adiciona o usuário ao grupo informado

Parâmetros de caminho

user_idstringobrigatório

O identificador único do usuário.

group_idintegerobrigatório

O identificador único do grupo de usuários.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/users/user_001/usergroups/4" \
  -u "$EMAIL:$API_KEY"

Remover um usuário de um grupo

Remove o usuário do grupo informado.

DELETE/api/users/{user_id}/usergroups/{group_id}Admin

Remove o usuário do grupo informado

Parâmetros de caminho

user_idstringobrigatório

O identificador único do usuário.

group_idintegerobrigatório

O identificador único do grupo de usuários.

Exemplo de requisição

bash

curl -X DELETE "$BASE_URL/api/users/user_001/usergroups/4" \
  -u "$EMAIL:$API_KEY"

Erros

Estes códigos de status valem para as chamadas sobre um grupo específico e para as chamadas de participação.

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 ou grupo de usuários com o ID informado.
`409 Conflict`	O usuário já é membro do grupo (`PUT`) ou o usuário não é membro do grupo (`DELETE`).

Veja também

API legada/Referência completa/Grupos de usuários

Endpoints de grupos

As URLs da API de Usergroups: gerencie os grupos e a participação dos usuários neles.

Estes endpoints criam, consultam, atualizam e excluem grupos de usuários, e gerenciam quais usuários pertencem a eles. Todos usam HTTP Basic com o e-mail:chave_de_api do administrador.

Listar grupos de usuários

Retorna os grupos de usuários da loja, com as informações de paginação em meta.

GET/api/usergroupsAdmin

Retorna todos os grupos de usuários

Exemplo de requisição

bash

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

Resposta

200Grupos de usuários retornados

json

{
  "data": [
    {
      "id": 3,
      "name": "Administrators",
      "description": "Users with full system access",
      "member_count": 5,
      "permissions": [
        "manage_users",
        "manage_products",
        "manage_orders",
        "manage_settings"
      ],
      "created_at": "2024-12-01T10:00:00Z"
    },
    {
      "id": 4,
      "name": "Sales Team",
      "description": "Sales department staff",
      "member_count": 12,
      "permissions": [
        "view_customers",
        "manage_orders",
        "view_products"
      ],
      "created_at": "2024-12-15T14:30:00Z"
    }
  ],
  "meta": {
    "total": 5,
    "page": 1,
    "per_page": 10
  }
}

Criar um grupo de usuários

Cria um novo grupo. O exemplo abaixo mostra um corpo com o nome do grupo, a descrição, as permissões e os usuários a incluir.

POST/api/usergroupsAdmin

Cria um novo grupo de usuários

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/usergroups" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Support Team",
  "description": "Customer support representatives",
  "permissions": [
    "view_customers",
    "view_orders",
    "manage_tickets",
    "respond_tickets"
  ],
  "users": [
    "user_003",
    "user_007",
    "user_012"
  ]
}'

Consultar um grupo de usuários

Retorna um grupo pelo ID.

GET/api/usergroups/{id}Admin

Retorna um grupo de usuários específico

Parâmetros de caminho

idintegerobrigatório

O identificador único do grupo de usuários.

Exemplo de requisição

bash

curl "$BASE_URL/api/usergroups/4" \
  -u "$EMAIL:$API_KEY"

Atualizar um grupo de usuários

Altera o grupo com o ID informado.

PUT/api/usergroups/{id}Admin

Atualiza um grupo de usuários específico

Parâmetros de caminho

idintegerobrigatório

O identificador único do grupo de usuários.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/usergroups/4" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Sales and Marketing Team",
  "description": "Combined sales and marketing department",
  "permissions": [
    "view_customers",
    "manage_orders",
    "view_products",
    "manage_marketing"
  ]
}'

Excluir um grupo de usuários

Exclui o grupo com o ID informado.

DELETE/api/usergroups/{id}Admin

Exclui um grupo de usuários específico

Parâmetros de caminho

idintegerobrigatório

O identificador único do grupo de usuários.

Exemplo de requisição

bash

curl -X DELETE "$BASE_URL/api/usergroups/4" \
  -u "$EMAIL:$API_KEY"

Listar os grupos de um usuário

Retorna todos os grupos de usuários a que um usuário específico pertence.

GET/api/users/{id}/usergroupsAdmin

Retorna todos os grupos a que o usuário pertence

Parâmetros de caminho

idstringobrigatório

O identificador único do usuário.

Exemplo de requisição

bash

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

Resposta

200Grupos do usuário

json

{
  "data": [
    {
      "id": 2,
      "name": "Registered users",
      "description": "Default group for all registered users",
      "permissions": [
        "view_products",
        "place_orders"
      ]
    },
    {
      "id": 4,
      "name": "Sales Team",
      "description": "Sales department staff",
      "permissions": [
        "view_customers",
        "manage_orders",
        "view_products"
      ]
    }
  ]
}

Adicionar um usuário a um grupo

Adiciona o usuário ao grupo informado.

PUT/api/users/{user_id}/usergroups/{group_id}Admin

Adiciona o usuário ao grupo informado

Parâmetros de caminho

user_idstringobrigatório

O identificador único do usuário.

group_idintegerobrigatório

O identificador único do grupo de usuários.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/users/user_001/usergroups/4" \
  -u "$EMAIL:$API_KEY"

Remover um usuário de um grupo

Remove o usuário do grupo informado.

DELETE/api/users/{user_id}/usergroups/{group_id}Admin

Remove o usuário do grupo informado

Parâmetros de caminho

user_idstringobrigatório

O identificador único do usuário.

group_idintegerobrigatório

O identificador único do grupo de usuários.

Exemplo de requisição

bash

curl -X DELETE "$BASE_URL/api/users/user_001/usergroups/4" \
  -u "$EMAIL:$API_KEY"

Erros

Estes códigos de status valem para as chamadas sobre um grupo específico e para as chamadas de participação.

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 ou grupo de usuários com o ID informado.
`409 Conflict`	O usuário já é membro do grupo (`PUT`) ou o usuário não é membro do grupo (`DELETE`).