Skip to content
PLUNKDOCS
Contact support

API keys

Before you start

Section titled “Before you start”
  • You need to be a workspace owner or admin.
  • Your plan must include the API. On other plans, creating a key says “The API is included with Studio Storefront and Plunk Commerce. Talk to us to add it to your plan.”
  • Decide where the key will run. Server code gets a Secret key. Website code gets a Publishable key, locked to your site’s domains. The developer guide explains the difference.

Create a key

Section titled “Create a key”
  1. Open Billing & Usage from the profile menu in Plunk Studio or Plunk Commerce.
  2. Go to the API tab and choose + Create key.
  3. Name it for what will use it, such as “ERP integration”.
  4. Choose the type. Secret for server-side code, or Publishable for website code.
  5. Add allowed origins for a publishable key: the site addresses that will call the API, separated by commas (for example https://www.example.com, https://shop.example.com).
  6. Choose Live or Test. Test keys are labelled for testing but use your real data.
  7. Create the key, then copy it. It’s shown only once.

Rename or revoke a key

Section titled “Rename or revoke a key”

On the key’s row choose Rename or Revoke. Revoking can’t be undone: anything using that key stops working immediately. To replace a key, create a new one, switch your code to it, then revoke the old one.

Limits

Section titled “Limits”

Each key allows 1,000 requests a day and 20,000 a month by default. For higher limits, ask through support. See errors and rate limits.

Visualizer App keys are different

Section titled “Visualizer App keys are different”

Keys for the COM/COL Visualizer, Sectional Builder and Room Planner are made in Plunk Studio under Visualizer Apps, not in Billing & Usage. See the Shopper App API overview.

Section titled “Related”
Was this helpful?

Still stuck? Contact support and include the job or page you were on.