Private API keys let your own systems, or a developer you work with, use the Wrapped API. Owners and Admins create them at Settings › Integrations and API keys, in the Private API keys section. API access is included on the Pro plan and above.
Who can manage keys
- Owners and Admins can see, create, rename and delete API keys.
- Members and Read-only users can't open the Integrations and API keys page. See Team members and roles.
- On the Basic plan you can open the page, but you can't create a key. Wrapped asks you to upgrade to Pro first. Owners change the plan at Settings › Plan and billing.
Create an API key
- Go to Settings › Integrations and API keys.
- In Private API keys, click Create API key.
- Under Description, say what the key is for, for example "Booking system" or "Agency: CRM sync". A description is required.
- Click Create key.
The key works as soon as it's created. It appears in the table with its description, who created it (Created by) and when (Created).
The description matters later: every gift card created through the API has a note saying it was created via the Wrapped API, followed by the key's description, and the same text appears on the card's timeline. A clear description tells you which system made a card.
Copy or show a key
The Key column shows the first six characters followed by dots. Use the eye button to show or hide the full key, and the copy button to copy it. You can see and copy a key here at any time; it isn't only shown once.
Give the key to your developer through a secure channel, such as a password manager. Don't send it in a chat message or put it in a web page or app.
Rename a key
Open the … menu on the key's row, choose Edit description, change the text and save. Renaming doesn't change the key itself, so nothing stops working. Gift cards created before the change keep the old description in their notes.
Delete a key
- Open the … menu on the key's row and choose Delete.
- In Delete this API key?, click Delete key.
Anything using that key stops working straight away and gets a 401 error from the API. This can't be undone; if you need access again, create a new key. Gift cards already created with the key aren't affected.
Rotate a key
To replace a key without downtime:
- Create a new key with a description that shows it's the replacement.
- Update your integration to use the new key and check that it works.
- Delete the old key.
Rotate keys when someone who had access leaves, when a key may have been exposed, or on a regular schedule.
What a key can do
- A key has full access to the Wrapped API for one Wrapped account: it can create, look up, adjust and void gift cards, manage webhooks and web store coupons, and send automation events. There are no read-only or limited keys.
- A key only works for the account it was created in. If you run several Wrapped accounts, create a key in each one. See Running several venues, brands or gift card programs.
- Keys don't expire. They work until they're deleted.
- There's no separate test key. Every key works on your live gift cards.
- Gift cards created with an API key count toward your monthly gift card allowance. See How the monthly gift card allowance works.
- Creating, renaming and deleting keys is recorded in the audit log.
Zapier and some other integrations use their own keys, which don't appear in Private API keys. The Zapier key is shown in the Zapier dialog on the same page. See Zapier integration.
Common questions
I clicked Create API key and was asked to upgrade. Why?
Your account is on the Basic plan. API access is included on Pro and above, so creating a key needs an upgrade first. See Plans and pricing.
Is there a limit on how many keys I can create?
Wrapped doesn't set a limit. Creating a separate key for each system or developer makes it easy to delete one without affecting the others.
Can I see which key made an API call?
Gift cards and adjustments created through the API are labelled with the description of the key that created them, on the card's notes and timeline. Wrapped doesn't show a log of individual API calls.
A developer's key stopped working. What happened?
The most likely cause is that someone deleted the key. Check Private API keys and the audit log, then create a new key if needed.
Where is the API documentation?
At wrappedgiftcards.readme.io. See also The Wrapped API for the key concepts and examples.