Authorization Tokens 1.0

Issue and revoke location-scoped JWT authorization tokens used by the POS API.

Authentication requires an Account Manager administrative token in the Authorization: Bearer <token> header. The authenticated user must be the active business administrator for the requested organization.

Server Admin Bearer token

Tokens

GET/v1/tokens/requestAuthorizationTokenIssue an authorization token

Creates a location-scoped JWT with a 30-day lifetime after validating the authenticated business administrator.

Parameters

Name	In	Description
`Authorization` required	header Bearer token	Account Manager administrative token.
`organizationId` required	query integer	Organization owned by the authenticated business administrator.
`locationId` required	query integer	Location to encode into the new authorization token.

Try it out

Request URL

—

Server response

—

GET/v1/tokens/revokeAuthorizationTokenRevoke an authorization token

Marks a previously issued POS authorization token as revoked using its database identifier.

Parameters

Name	In	Description
`Authorization` required	header Bearer token	Account Manager administrative token.
`apiLocationTokenId` required	query integer	Identifier returned when the POS authorization token was issued.

Try it out

Request URL

—

Server response

—

Response models

Application responses use the envelope { status, message, data }.

Issued token data

Property

Type

Description

tokenType

string

Authentication scheme; currently Bearer.

authorizationToken

string

Signed JWT used to authorize POS API requests.

apiLocationTokenId

integer

Database identifier used to revoke this token.

expiresIn

integer

Lifetime in seconds; currently 2,592,000 (30 days).

Revocation data

Property

Type

Description

revoked

boolean

Whether a token record was updated.

affectedRows

integer

Number of matching token records updated.