Pular para o conteúdo principal

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

NomeTipoDescrição
userIdnumberIdentificador do usuário
establishmentIdnumberIdentificador do estabelecimento
clientIdstringIdentificador do cliente

Corpo (JSON)

CampoTipoObrigatórioDescrição
establishmentIdnumbersimEstabelecimento ao qual o token será vinculado.
tokenstringsimValor 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:

CampoTipoDescrição
idnumberIdentificador interno do token (usado para remoção).
establishmentIdnumberEstabelecimento ao qual o token pertence.
clientIdstringCliente ao qual o token está vinculado.
tokenstringValor do token cadastrado.
created_atstringData de criação.
updated_atstringData 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ódigoHTTPSituação
01029400Campo token ausente ou vazio.
01030400Já 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 token deve 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_history com activityTypeId = UPDATE e activitySourceId = CLIENT_TOKEN.
  • O registro também é marcado para sincronização via SyncedItem, permitindo que clientes offline recebam a alteração.