Shippo uses 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 your API needs, please request an API token from this link if you haven't done so already. Please note that all users wanting to utilize Shippo’s API will be required to use 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 methods generate the same type of Live API Token—choose the option that matches where you manage your account.
Live vs Test API Tokens
Live API Token
Use this token for production workflows, including creating real shipping labels and accessing live carrier accounts.Test API Token
Use this token to test the API end-to-end and purchase test shipping labels. To use test labels, your carrier accounts must also be set to Test Mode. Learn more in our Test Mode documentation.
|
Note:
|
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 will review your request and follow up if additional information is needed. Once approved, your Live API Token will be available in the Shippo Web App and API portal. |
Retrieve a Token
Tokens are masked in your dashboard for security and cannot be retrieved. You will only be able to view your token one time when you first generate the token. Please make a note of it at that time.
You'll see a pop-up window displaying your test token and a message reminding you it is the only time it can be viewed.
Manage your Tokens
You can have up to two active Live tokens and two active Test tokens for a single Shippo account. If you have two active tokens, the Generate Token button will change to Max of 2 tokens reached.
To generate a new token when you've already reached the maximum of two, you'll need to remove one first. Click on the Manage Your Tokens button, remove one of your tokens, and click Done. Then, you can generate another one with the Generate Token button (for test tokens) or request a live API token from this link.
|
Important: Save Your API Token For security reasons, Shippo does not store copies of your API tokens. When you generate a Live API Token or Test API Token, it is shown only once. After you navigate away from the page, Shippo cannot retrieve or display the full token again. If you lose your API token, you will need to generate a new one and update any applications or integrations using the old token. |