We use API tokens to authenticate requests to our API. Use a test token while you build and a live token when you’re ready for production.
| Note: To get started with the API, request a token from the Shippo API Portal. |
Live vs. test tokens
- Live token: Use it for production workflows, including creating real shipping labels and accessing your live carrier accounts.
- Test token: Use it to test the API end to end and buy test shipping labels. For test labels to work, your carrier accounts also need to be in test mode. Learn more in our test mode documentation.
| Note: “Token” and “key” mean the same thing. You’ll see “token” in the Web App and “key” in the API Portal. |
Generate a live token
You can request a live token in the Shippo Web App or the Shippo API Portal. Both give you the same type of token, so use whichever one you already manage your account in.
Request a live token in the Web App
- Log in to the Shippo Web App.
- Go to Settings.
- Click the API tab.
- In the Live Token section, click Request Live Token.
| Note: Need a test token? In the Test Token section, click Generate Token. |
Request a live key in the API Portal
- Log in to the Shippo API Portal.
- In the API configuration menu, select Developer keys.
- In the Live keys section, click Create new live key.
- Copy your key, then click Close.
| Note: Live keys begin with shippo_live_. To create a test key, click Create new test key in the Test keys section. Test keys begin with shippo_test_. |
Save your token
We show your full token once, when you create it. After that, it’s masked in your dashboard and we can’t retrieve it for you. In the Web App, a pop-up window shows your token and reminds you that this is your only chance to see it. In the API Portal, copy your key before you click Close.
| Warning: Your tokens give direct access to your Shippo account, so store them somewhere secure. If you think a token has been compromised, delete it in your dashboard and generate a new one. |
| Note: If you lose a token, generate a new one and update any apps or integrations that used the old one. |
Manage your tokens
You can have up to 2 active live tokens and 2 active test tokens on a single Shippo account. The API Portal has the same limit. In the Web App, once you have 2 active tokens of a type, the button changes to Max of 2 tokens reached.
To make room for a new token in the Web App, remove an existing one first:
- Click Manage your token.
- Remove one of your tokens.
- Click Done.
- For a test token, click Generate Token. For a live token, click Request Live Token and follow the steps in “Request a live token in the Web App.”