Grupos de usuários

Agrupe usuários para gerenciar permissões, regras de preço e acesso a conteúdo, e controle quem participa de cada grupo.

Um grupo de usuários é um conjunto nomeado de usuários. Os grupos permitem dar as mesmas permissões, preços ou acesso a conteúdo a muitas contas de uma vez. Um grupo pode reunir administradores (que passam a compartilhar privilégios) ou clientes (por exemplo, níveis de fidelidade, grupos de acesso especial ou divisões organizacionais).

Você usa os endpoints de Usergroups para criar e manter os próprios grupos, e os endpoints de participação em /api/users/... para dizer quem pertence a qual grupo. Todos usam HTTP Basic com o e-mail:chave_de_api do administrador.

Como funciona

Os grupos de usuários são uma forma de segmentar a base de clientes e oferecer experiências diferentes conforme a participação. As operações comuns são criar e atualizar grupos, atribuir usuários a grupos, remover usuários de grupos, verificar a participação e definir permissões específicas do grupo.

Crie o grupo
Envie POST /api/usergroups com o type, o status e o nome (usergroup). A resposta traz o novo usergroup_id. Veja Exemplos.
Adicione usuários
Use PUT /api/users/{user_id}/usergroups/{group_id}. Veja Usuários e grupos.
Encontre os grupos depois
Filtre a lista com type e status, veja Filtros.

Status do grupo

Código	Significado
`A`	Ativo
`H`	Oculto
`D`	Desativado

Status de participação do usuário

Dentro de um grupo, cada usuário tem o seu próprio status.

Código	Status	Significado
`A`	Ativo (Active)	O usuário é membro do grupo.
`F`	Disponível (Available)	O usuário não é membro do grupo.
`P`	Pendente (Pending)	O usuário pediu para entrar no grupo.
`D`	Recusado (Declined)	O pedido do usuário para entrar no grupo foi recusado.

Conceitos-chave

Tipos de grupo

A Venddor oferece diferentes tipos de grupos de usuários.

Grupos de administradores. Seus usuários têm permissões elevadas e podem gerenciar as configurações da plataforma, os pedidos e outras funções administrativas.
Grupos de clientes. Grupos comuns para classificar clientes, como níveis de fidelidade, grupos de acesso especial ou divisões organizacionais.
Grupos de vendedores. Grupos para organizar os vendedores da plataforma com permissões e capacidades específicas.

Na tabela de campos, o type de um grupo recebe A (administradores) ou C (clientes).

Método	Caminho	Para quê	Autenticação	Página
GET	`/api/usergroups`	Retorna todos os grupos de usuários.	Basic (admin)	Endpoints
POST	`/api/usergroups`	Cria um novo grupo de usuários.	Basic (admin)	Endpoints
GET	`/api/usergroups/{id}`	Retorna um grupo de usuários específico.	Basic (admin)	Endpoints
PUT	`/api/usergroups/{id}`	Atualiza um grupo de usuários específico.	Basic (admin)	Endpoints
DELETE	`/api/usergroups/{id}`	Exclui um grupo de usuários específico.	Basic (admin)	Endpoints
GET	`/api/users/{id}/usergroups`	Retorna os grupos a que um usuário pertence.	Basic (admin)	Endpoints
PUT	`/api/users/{user_id}/usergroups/{group_id}`	Adiciona um usuário a um grupo.	Basic (admin)	Endpoints
DELETE	`/api/users/{user_id}/usergroups/{group_id}`	Remove um usuário de um grupo.	Basic (admin)	Endpoints

Erros comuns

Tentar alterar ou excluir o grupo 1 ou 2. Eles são reservados.
Procurar os grupos 1 e 2 em uma listagem. Eles só aparecem quando você os pede diretamente.
Excluir um grupo que ainda tem usuários. Remova ou mude os usuários antes.
Adicionar um cliente a um grupo de administradores. A API responde 400 Bad Request.
Enviar privileges em um grupo de clientes esperando algum efeito. Os privilégios só valem para grupos de administradores.
Esperar, nos grupos de um usuário, os grupos com status de participação Available (F). Eles não são devolvidos.

Próximos passos

Endpoints

Todas as URLs da API de Usergroups.

Usuários e grupos

Adicione e remova membros.

Campos do grupo

Campos, tipos e status de um grupo.