🔑 Picqer Fulfilment: Admin vs. Scoped API Keys
When connecting Optiply to a Picqer Fulfilment environment, you can use two different types of API keys: Admin and Scoped. It is essential to understand the difference between them, as they change how your supplier data is managed.
⚖️ API Key Types: How They Affect Your Setup
Feature | Scoped API Key | Admin (Unscoped) API Key |
Access Level | Specific strictly to your company's objects. | Full access across the whole organisation. |
Supplier Sync | ❌ Cannot access or sync supplier objects. | ✅ Syncs supplier objects automatically. |
Scenario A: Using a Scoped Key (No Admin Access)
Because a Scoped Key cannot "see" your supplier objects in Picqer, Optiply handles suppliers differently. Whenever a buy order comes from Picqer, Optiply will automatically create a supplier based purely on the text in the supplier_name field of that buy order.
Note: Because you don't have linked suppliers in the source system, this text field is your only reference. This is useful for manual management but requires strict naming consistency to avoid a messy, duplicated supplier list!
Scenario B: Using an Admin Key
With an Admin Key, the setup works exactly like a normal Picqer integration. We sync the supplier objects directly from Picqer and automatically update them in Optiply whenever you make changes.
⚠️ Crucial Warning on Changing Key Types:
It is very important to know which API key you are using. Switching from a Scoped Key to an Admin Key (or vice versa) requires completely different data sets and configurations on our end. If you ever need to change your key type, you must contact us at support@optiply.nl before doing so!
🛠️ How to Generate a Scoped API Key
If you need to generate a Scoped API Key for your setup, follow these exact steps:
Navigate to API Keys: Log in to Picqer and go to your API configurations via this link: https://redirect.picqer.com/config/apikeys
Create New Key: Click on the + New API Key button located in the upper right corner.
Select Your Client (Crucial Step): To generate a Scoped key, you must select a fulfilment client from the dropdown menu.
If you leave this blank and do not select a client, Picqer will generate an unscoped Admin key instead.
5. Generate: Click Add API key.
6. Save immediately: The newly generated API key will be shown to you only once. Please copy and save it securely right away. If you lose it, you will have to delete it and generate a brand new one.
Once you have your Scoped API Key ready, please email it directly to our integrations team at integrations@optiply.com so we can finalise your setup!
❓ Frequently Asked Questions (FAQs)
What happens if I lose my API key before sending it to Optiply?
Because Picqer only displays the API key once for security reasons, it cannot be recovered. You will need to delete the lost key in your Picqer settings and generate a new one by following the steps above.
Why are my suppliers duplicating in Optiply?
If you are using a Scoped API Key, Optiply creates suppliers based on the exact text in the supplier_name field on your buy orders. If there is a typo or a slight variation in the name (e.g., "Supplier A" vs. "Supplier A Inc."), Optiply will treat them as two separate suppliers.