Adiciona token ao cliente
POST /api/{userId}/establishment/{establishmentId}/clients/{clientId}/tokens
Vincula um novo token ao cliente em um estabelecimento.
Parâmetros de rota
| Nome | Tipo | Descrição |
|---|---|---|
userId | number | Identificador do usuário |
establishmentId | number | Identificador do estabelecimento |
clientId | string | Identificador do cliente |
Corpo (JSON)
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
establishmentId | number | sim | Estabelecimento ao qual o token será vinculado. |
token | string | sim | Valor do token a ser cadastrado. |
Requisição
- Método:
POST - Path:
/api/\{userId\}/establishment/\{establishmentId\}/clients/\{clientId\}/tokens - Headers:
Authorization,Accept: application/json,Content-Type: application/json
Exemplo
curl -X POST "$JUMP_API_BASE_URL/api/{userId}/establishment/{establishmentId}/clients/{clientId}/tokens" \
-H "Authorization: Bearer <YOUR_API_TOKEN>" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"establishmentId": 7724,
"token": "ABC123XYZ"
}'
Formato da resposta (JSON)
Segue o envelope padrão da API:
- Sucesso (HTTP 200):
{ "response": "success", "data": <payload> } - Erro (HTTP 400):
{ "response": "error", "data": { "msg": "...", "code": "..." } }
Payload de sucesso
data contém o registro recém-criado em jump_client_tokens:
| Campo | Tipo | Descrição |
|---|---|---|
id | number | Identificador interno do token (usado para remoção). |
establishmentId | number | Estabelecimento ao qual o token pertence. |
clientId | string | Cliente ao qual o token está vinculado. |
token | string | Valor do token cadastrado. |
created_at | string | Data de criação. |
updated_at | string | Data da última atualização. |
Exemplo de resposta (JSON)
{
"response": "success",
"data": {
"establishmentId": 7724,
"clientId": "772420260215093421",
"token": "ABC123XYZ",
"updated_at": "2026-04-24 15:48:02",
"created_at": "2026-04-24 15:48:02",
"id": 37
}
}
Erros
| Código | HTTP | Situação |
|---|---|---|
01029 | 400 | Campo token ausente ou vazio. |
01030 | 400 | Já existe um token idêntico vinculado ao mesmo establishmentId (conflito) ou falha interna ao criar o registro. |
Exemplo de erro (token duplicado)
{
"response": "error",
"data": {
"msg": "Token já cadastrado para este estabelecimento.",
"code": "01030"
}
}
Nuâncias
- O valor do
tokendeve ser único por estabelecimento. O mesmo valor pode existir em estabelecimentos distintos. - Um cliente pode ter múltiplos tokens no mesmo estabelecimento. Para listar todos os tokens atuais, use Lista tokens do cliente.
- A criação registra um evento em
activity_historycomactivityTypeId = UPDATEeactivitySourceId = CLIENT_TOKEN. - O registro também é marcado para sincronização via
SyncedItem, permitindo que clientes offline recebam a alteração.