Skip to main content

Manage API keys

An API key lets software use the QRForge API on behalf of your account. Treat it like a password.

The number of keys you can have depends on your plan: Pro 1, Agency 3, Enterprise unlimited. Agency can add more with the API Keys Add-On.

Where to find your keys​

  1. In the left menu, click Subscription.
  2. Open the Manage Plan tab.
  3. Scroll to API Keys.

The table shows each key's Label, Last 4 characters, Status (Active or Revoked) and the date it was Created. The full key is never shown again after you create it.

The API Docs link opens the developer documentation.

Create a key​

  1. Under API Keys, click Create key.
  2. In Create API Key, enter a Label that says what the key is for, for example Website shop sync.
  3. Click Create.
  4. You see "New API key created. Copy your key now — it will not be shown again." Click Copy to clipboard.
  5. Store the key somewhere safe, such as a password manager.
  6. Click Dismiss.

If you lose a key, you cannot see it again. Revoke it and create a new one.

Revoke a key​

Revoke a key when you stop using an integration, when someone who had the key leaves, or if you think the key was shared by mistake.

  1. Under API Keys, find the key by its Label and Last 4.
  2. Click Revoke.

The key stops working at once. Any software using it gets an error. Revoking also frees a place, so you can create a new key.

Remove a revoked key​

A revoked key stays in the list so you can see its history. To clean up:

  1. Click Remove on the revoked key.
  2. Confirm with Remove Key. This cannot be undone.

Keep your keys safe​

  • One key per integration. Then you can revoke one without breaking the others.
  • Never put a key in a website's code, in an app, or in a shared document. Anyone who sees it can use your account through the API.
  • Do not send keys by email or chat. Use a password manager to share them.
  • Revoke keys you no longer use.
  • Act fast if a key leaks. Revoke it, create a new one, and update your integration.

Troubleshooting​

"You have reached the maximum number of API keys allowed." Revoke a key you no longer need, upgrade, or (on Agency) buy the API Keys Add-On.

"API keys are not enabled for your current subscription." Your plan does not include the API. See Plans and what's included.

"Give this key a name to continue." Enter a Label before clicking Create.

"Could not create a new key. Please try again." / "Could not revoke this key. Please try again." Check your internet connection and try again.

"Could not load your API keys. Please refresh the page and try again." Reload the page.