API keys
The Picqer API lets other software connect to your Picqer account. For example to read data automatically, create new orders or get a real-time notification when stock changes.
Access to the API requires an API key. That is a key made specifically for the API. Nobody can use it to sign in to your Picqer account itself.
Only give an API key to people or companies you trust. With an API key, someone has (automated) access to the data in your Picqer account. Trusted someone before, but not anymore? Revoke the key.
Creating an API key
Go to 'Settings' > 'API keys' and click 'New API key'.
Give the key a name, so you know what you use it for. Click 'Add API key'.
Picqer shows the key once, as a long string of characters. Store it right away, you cannot retrieve it later. This is the key you give to the app or developer.
You can add as many API keys as you like. Use a separate key for each service or developer, so you can revoke one later without stopping the others.
Limiting a key to a fulfilment customer
Do you use fulfilment? Then the form also has a 'Fulfilment customer' field. Leave it empty to create a global key. That key gives access to your whole account, including all fulfilment customers. Pick a fulfilment customer and the key only sees that customer's data.
You can hand such a scoped key to your fulfilment customer, for example to connect their store or point-of-sale system. The API documentation for fulfilment customers lists which parts of the API work with it.
This is the only way to limit a key. A key without a fulfilment customer always has access to the full API.
Revoking a key
Has a key leaked, or do you no longer use an integration? Click 'Revoke key' next to that key. The integration stops immediately. If you want to use it again later, create a new key.
Read more about what the API can do on the API page.
