Authorization

The following explanation is only applicable in the case of using the piggy api for connecting Registers or POS systems. Registers are considered 'dumb' devices and will therefore not need OAuth logic. This means that the API calls for the register require a simpler form of authentication. All registers have an API-key directly linked. This means that authentication will be performed on a per-register basis.


Creating a Register API-key

Register API-keys can be created in the Business Dashboard. When logged into the Business Dashboard go to Integrations, then POS-integration. You can create new Registers here. A Register API-key will be created automatically for each Register upon creation.

You can then link a Register to a Device, which is in turn linked to a Shop. This way, we can tell for which Shop each transaction is to be created. If you haven't created any Shops or Devices yet, you can do so in the Business Dashboard. To create a Shop, got to Management, then Shops. To create a Device, go to Management, then In-Store Management, then Devices and link a new Device using Link codes.

After that, you authorize all API calls with the following header.

The header format is:

Authorization: Bearer {register-api-key}


Related