We use API tokens to authenticate requests made to our API. You'll use different tokens depending on whether you're testing or working in production.
| Note: To get started with the API, request an API token from this link if you haven't already. All users looking to use Shippo's API need to go through this link. |
Generate a live API token
You can request a Live API Token in either the Shippo Web App or the Shippo API Portal. Both generate the same type of token, so pick whichever matches where you manage your account.
Live vs. test API tokens
- Live API Token: use this for production workflows, including creating real shipping labels and accessing live carrier accounts.
- Test API Token: use this to test the API end-to-end and buy test shipping labels. To use test labels, your carrier accounts also need to be set to test mode. Learn more in our test mode documentation.
| Note: To generate a Live Token, request an API token from this link. Also, “Token” and “key” are used interchangeably in the Shippo UI. |
Request a live token in the Shippo 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.
Request a live token in the Shippo API Portal
- Log in to the Shippo API Portal.
- Click the Developer keys tab.
- In the Live keys section, click Request live key.
| Note: Our API team reviews your request and will follow up if they need more information. Once approved, your Live API Token will be available in both the Shippo Web App and the API portal. |
Retrieve a token
Tokens are masked in your dashboard for security and can't be retrieved after the fact. You'll only be able to view a token once, when you first generate it, so make a note of it right away.
A pop-up window will show your token along with a reminder that this is the only time you'll be able to see it.
Manage your tokens
You can have up to two active Live tokens and two active Test tokens on a single Shippo account. Once you have two active tokens of a type, the Generate Token button changes to Max of 2 tokens reached.
To generate a new token once you've hit that limit, remove one first. Click Manage Your Tokens, remove one of your tokens, and click Done. Then generate another with the Generate Token button (for test tokens), or request a new live token from the link above.
| Important: save your API token For security reasons, we don't store copies of your API tokens. When you generate a Live or Test API Token, it's shown only once. After you navigate away from the page, we can't retrieve or display the full token again. If you lose your token, you'll need to generate a new one and update any applications or integrations that used the old one. |