Purpose
Prepare the key that lets the integration access the agreed Picqer data. Creating a key does not add the source in Optiply or start a synchronization; continue with Connect Picqer after preparation.
Prerequisites
Ask a Picqer administrator to create the key; API-key settings are reserved for administrators. Confirm the correct Picqer organisation and whether this is standard Picqer or a Fulfilment connection. For Fulfilment, agree the intended customer scope before creating anything.
Use secure storage that your organisation approves. Each integration should have its own key so one service can be revoked without stopping unrelated services.
Steps
- Sign in to the intended Picqer organisation as an administrator. Open Settings → API keys and choose New API key.
- Give the key a recognisable name, such as Optiply, so you can identify its purpose later.
- For an account with fulfilment features, check Fulfilment customer. Selecting a customer limits the key to that customer's data. Leaving it empty creates a global key with access across the account, including all fulfilment customers. Confirm the intended scope before continuing; do not leave this empty just to bypass a permission problem.
- Choose Add API key. Copy the generated key into your approved secure storage immediately. Picqer displays the key only once; you cannot retrieve it later.
- Continue through the appropriate Optiply connection guide. Enter the key only in the designated credential field or through the secure method arranged during setup.
These are the key-creation steps in Picqer's API-key instructions.
Fields and columns
- Name: identifies what the key is used for; it does not limit access.
- Fulfilment customer: limits the key to one customer's data when selected. An empty selection means global access, not a harmless default.
- API key: the generated secret used by the integration, not your Picqer sign-in password. Never include its value in support messages, shared documents or screenshots.
Expected result
You have a securely stored, recognisable key with the intended scope. You still need to complete Optiply setup and check data arrival separately.
Limitations
A scoped key exposes only the API operations available to that fulfilment customer. A global key grants broader access; it does not automatically change Optiply's supplier-handling configuration.
Errors and recovery
If API-key settings are unavailable, ask your Picqer administrator rather than changing user rights yourself. If you lose the one-time key, create a replacement and coordinate its installation before revoking the old working key. If a key is exposed, revoke it promptly in Picqer and contact Support about restoring the connection securely. Revocation stops the integration immediately; it is not a synchronization retry.