API keys

• ERP integration: Sync products and packaging data between ERP and Reguly.
• Channel partners: Wholesalers or marketplaces can fetch DOCs and DPPs at the press of a button.
• BI analyses: Read Reguly data into Looker, Power BI, Metabase etc.
• Custom apps of your own: When you build your own app that should display Reguly data.

1. 1

   Open the key area

   In the dashboard under 'Insights → API keys'. You see a list of all existing keys.

2. 2

   Generate new key

   Click 'Create new key'. Enter a meaningful name (e.g. 'Power BI Sync') and pick permissions.

3. 3

   Set permissions

   Per area you choose: read, write or no access. Example: read-only on products and DOCs, no access on account.

4. 4

   IP restriction (optional)

   You can specify which IP addresses the key is valid from — extra security when your third-party system has a fixed IP.

5. 5

   Copy the key

   Reguly shows the key once in plain text — copy it now and store it securely. We cannot show the key again.

6. 6

   Enter key in third-party system

   In the third-party system you enter the key as a bearer token. Reguly uses OAuth-2.0 bearer auth for maximum compatibility.

Reguly offers a REST API with the following main endpoints:

• /api/v1/products — read, create, update products.
• /api/v1/docs — read, generate DoCs.
• /api/v1/passports — read, update DPPs.
• /api/v1/reports — read, export quantity reports.
• /api/v1/analytics — read anonymised reach data.

Full endpoint reference with examples can be found at https://reguly.eu/api/docs.

• Standard plan: 60 requests/min, 10,000 requests/day
• Pro plan: 300 requests/min, 100,000 requests/day
• Enterprise: on agreement

On exceeding, Reguly responds with HTTP 429 and a Retry-Afterheader. You also see current rate limits in the dashboard.