API Keys
Open: API Keys in the left menu. Available to restaurant administrators.
An API key identifies a cash-register integration device. It is separate from the passkey used to sign in as a person.
Generate a key
- Choose Add API key.
- Select the location that the integration will serve.
- Choose Generate API key.
- Find the new entry and click its displayed identifier to copy it.
- Configure the integration with that key and the correct application address.
Treat the copied identifier as a credential. Do not include it in screenshots or public support messages. The creation dialog does not offer reassignment to another location; generate a key for the intended location.
Read connection information
| Indicator | Meaning |
|---|---|
| Connected clients | Number of active service event-stream connections for the key. |
| SSE badge | At least one service connection is open. |
| Time since last call | Time since the last reported cash-register polling call. |
| Attention | Polling has not been observed recently and no SSE connection is displayed. |
| Dash | No last-call time is available. |
A connection badge is not a receipt for an order. Use Tables to inspect a session's orders and Messages to inspect commands.
Remove a key
Stop the integration's service connections first. Deletion is disabled while clients remain connected. Remove the obsolete key only when it is no longer needed; its configured integration will need a valid key to continue.
The current creation dialog has no field for restoring a previous identifier. Do not expect a deleted credential to be recovered through this screen.
For request headers and integration behavior, see API authentication.
Replace an integration key
- Generate a new key for the same intended location.
- Arrange a controlled switch with the integration operator and update the client's credential.
- Check the new key's connection information and verify a test operation at the cash register.
- Stop connections using the old key. Once its connected-client count is zero, delete it.
Coordinate the switch so two clients do not process the same work. If authentication fails, check the application address and the exact key configured on the client before generating more keys.