Aparência
Gestão — Tokens de API
"Tokens de API" são usuários com o papel API vinculados à conta, usados em integrações máquina a máquina. As rotas ficam em /access/manager/api-tokens (Access\ApiUsersController) e operam sobre a conta ativa (header account).
Até 03/10/2026 esta página descrevia
/access/api-tokens, com campospermissions,keyetoken. Essas rotas não existiam (o controller correspondente era código morto e foi apagado). Os caminhos e respostas abaixo são os reais.
O id usado nas rotas é o do vínculo usuário↔conta (data.id), não o do usuário (data.user.id).
GET /access/manager/api-tokens
Query: search (nome, e-mail ou documento), per_page (padrão 100), page.
json
{
"data": [
{
"id": 2,
"user_id": 2,
"account_id": 1,
"user": { "id": 2, "name": "Integracao ERP", "email": "erp@exemplo.com", "phone": null, "document": "52998224725", "status": 1 },
"role": { "id": 1, "name": "API" },
"created_at": "2026-10-03T13:52:00.000000Z",
"updated_at": "2026-10-03T13:52:00.000000Z"
}
],
"meta": { "total": 1, "page": 1, "limit": 100, "total_pages": 1, "has_next_page": false, "has_prev_page": false },
"message": "Lista de usuários API recuperada com sucesso!"
}POST /access/manager/api-tokens
| Campo | Regras |
|---|---|
name | Obrigatório, até 30 caracteres |
email | Obrigatório, e-mail único entre os usuários |
document | Obrigatório, único entre os usuários |
phone | Opcional |
Response 201: o vínculo criado, no mesmo formato de um item da lista, com message: "Usuário API criado com sucesso!".
GET /access/manager/api-tokens/{id}
O vínculo, em data. De outra conta ou sem papel API: 404.
PUT /access/manager/api-tokens/{id}
Mesmos campos do POST. O e-mail e o documento podem continuar os mesmos. A unicidade ignora o próprio usuário; trocar para o e-mail ou o documento de outro usuário responde 422.
Corrigido em 03/10/2026: a validação lia o parâmetro
api_user, mas a rota usa{api_token}. Por isso qualquer edição que mantivesse o e-mail ou o documento falhava com "já está sendo utilizado".
DELETE /access/manager/api-tokens/{id}
Remove o vínculo e responde com ele em data e message: "Usuário API removido com sucesso!".
Como a integração se autentica
http
POST /access/account/get-token
Content-Type: application/json
{ "email": "erp@exemplo.com", "token": "{token da conta}" }email: o e-mail do usuário API.token: o token da conta (accounts.token).- A resposta traz um JWT válido por 10 minutos, com as permissões do vínculo em
abilities.