Pular para o conteúdo principal
Módulos

Usuários

Nem toda integração precisa de acesso total. O módulo de Usuários controla quem entra no painel administrativo da Frota162 — e com quais permissões. Cada usuário pertence a um grupo de permissões e pode ser associado a uma ou mais empresas da sua conta.

Criar o usuário pela API já devolve o secretKey e o accessToken dele, prontos para autenticar as requisições HMAC — ou seja, dá para provisionar acesso programaticamente, sem depender do painel.

2 min de leituraVale para v1

O que dá para fazer

AçãoEndpointQuando usar
Listar gruposGET /key/user-groupsDescobrir o group_user_id antes de criar um usuário
Criar usuárioPOST /key/create-userProvisionar acesso de um novo usuário
Desativar usuárioDELETE /key/disable-user/{id_user}Revogar o acesso de um usuário
Reativar usuárioGET /key/enable-user/{id_user}Restaurar o acesso de um usuário
Antes de começar

Todas as chamadas usam os três headers de autenticação: Authorization, Key e cache-control. Ainda não tem as credenciais? Veja os Primeiros passos.


Grupos de usuários

Antes de criar um usuário, consulte os grupos disponíveis para obter o group_user_id correto.

GET/key/user-groups
curl -X GET \
https://apidev.v1.frota162.com.br/key/user-groups \
-H 'Authorization: Basic SEU_ACCESS_TOKEN' \
-H 'Key: SUA_ASSINATURA_HMAC'

Resposta

{
"groups": [
{
"id": 1,
"name": "Administrador",
"level": 1
},
{
"id": 2,
"name": "Operador",
"level": 2
}
],
"error": false
}

Criar usuário

POST/key/create-user

Cadastra um usuário com acesso ao painel. Todos os campos são obrigatórios: além dos dados de login, informe o group_user_id (de /key/user-groups) e a lista companies_ids com as empresas que o usuário poderá acessar.

curl -X POST \
https://apidev.v1.frota162.com.br/key/create-user \
-H 'Authorization: Basic SEU_ACCESS_TOKEN' \
-H 'Key: SUA_ASSINATURA_HMAC' \
-H 'Content-Type: application/json' \
-d '{
"name": "João Silva",
"username": "joao.silva",
"email": "joao@empresa.com",
"password": "senha123",
"password_confirm": "senha123",
"group_user_id": 2,
"companies_ids": [1, 3]
}'

Campos

CampoTipoObrigatórioDescrição
namestringSimNome completo do usuário
usernamestringSimNome de usuário para login
emailstringSimE-mail de acesso
passwordstringSimSenha
password_confirmstringSimConfirmação da senha (deve ser igual a password)
group_user_idintegerSimID do grupo de permissões (use /key/user-groups)
companies_idsarraySimLista de IDs das empresas às quais o usuário terá acesso

Resposta

{
"message": "Usuário cadastrado com sucesso",
"error": false,
"user": {
"id": 10,
"name": "João Silva",
"username": "joao.silva",
"email": "joao@empresa.com",
"group_user_id": 2,
"account_id": 5,
"secretKey": "...",
"accessToken": "..."
}
}
observação

A resposta inclui secretKey e accessToken do novo usuário. Guarde esses valores com segurança — eles são usados para autenticar requisições HMAC desse usuário.


Desativar usuário

DELETE/key/disable-user/{id_user}

Remove o usuário do painel — ele perde o acesso imediatamente, mas o cadastro permanece e pode ser restaurado.

curl -X DELETE \
https://apidev.v1.frota162.com.br/key/disable-user/10 \
-H 'Authorization: Basic SEU_ACCESS_TOKEN' \
-H 'Key: SUA_ASSINATURA_HMAC'

Resposta

{
"message": "Usuário desabilitado com sucesso",
"error": false
}

Reativar usuário

GET/key/enable-user/{id_user}

Restaura o acesso de um usuário desativado, mantendo o mesmo cadastro e permissões.

curl -X GET \
https://apidev.v1.frota162.com.br/key/enable-user/10 \
-H 'Authorization: Basic SEU_ACCESS_TOKEN' \
-H 'Key: SUA_ASSINATURA_HMAC'

Próximos passos