Skip to main content
The agent runs on Windows 10 or 11 on the back-office PC — the machine that can already reach your POS back-office data.

Get the store’s API key

1

Open Business Settings

Administration → Business Settings → Store Agent API Keys. There is one card per store.
2

Generate the key

You need permission to change settings — normally an owner or admin.
3

Copy it now

The key is shown once. It is not displayed again after you leave the page.
Keys can only be issued from the dashboard — the agent cannot create one for itself. Treat the key like a password: it authorises a machine to send data as that store.

Set the agent up

1

Install and launch it

It appears in the system tray.
2

Enter the store ID and API key

On the setup screen. Credentials are stored in the Windows Credential Manager, never in a plain file.
3

Choose the connector

How it reads your POS — see Connectors.
4

Check it in the dashboard

The store should show as online under Backoffice Agent Status, and in the store switcher.
One agent per store. Installing a second one for the same store is not supported.

Rotating or revoking a key

The same settings card can rotate, disable or revoke a key. Revoking one stops that machine sending data immediately — do it if a back-office PC is replaced, lost, or leaves your control, then generate a new key for the replacement.