> ## Documentation Index
> Fetch the complete documentation index at: https://docs.goshippo.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Shippo is a multi-carrier shipping API. For agent integrations that execute shipping operations (rates, labels, tracking, address validation, customs), connect the hosted Shippo MCP server at https://mcp.shippo.com (per-user OAuth; setup at /guides/mcp-server). To search and read this documentation from an agent, a docs search MCP is available at https://docs.goshippo.com/mcp. Shipping workflow knowledge (agent skills and a knowledge pack) is published at https://github.com/goshippo/ai. For REST integrations start at /guides/api-quickstart; test mode uses shippo_test_ API keys.

# Prerequisites

> Set up your Shippo account and generate an API key before you start integrating with the Shippo API.

Before integrating Shippo's API into your e-commerce platform, you will need the following:

* **Shippo Account**: You will need a functional Shippo account to access the API. If you do not have a Shippo account yet, you can sign up for one at [https://goshippo.com/register](https://goshippo.com/register).

* **API Key**: You will also need an API key to authenticate your requests to the API. Complete the steps in [Getting an API key](#getting-an-api-key) to get your API key.

## Getting an API Key

To use Shippo's API, you will need to authenticate your requests with an API key. Here are the steps to obtain an API key:

1. Log in to the Shippo API portal at [https://portal.goshippo.com/api-config/api](https://portal.goshippo.com/api-config/api) using your Shippo credentials.

2. In **Developer keys** under **API configuration**, click **Create new live key** for a live key or click **Create new test key** for a test key.

3. Once you have create an API key, copy it to your clipboard, as it will not be shown again.

4. You can now use the API key to authenticate your requests to Shippo's API by including it in the `Authorization` header of your HTTP requests.

   For example, if your API key is `shippo_test_token`, your `Authorization` header should look like this:
   `Authorization: ShippoToken shippo_test_token`

Please note that you should keep your API key confidential and not share it with unauthorized personnel. If you suspect that your API key has been compromised, you should regenerate it immediately from the Shippo dashboard.

There are two key decisions that will form the foundation of a Shippo integration. The first is how shipper accounts will be created and managed and the second is how the user interface will be built and maintained. Once these two foundational points are determined User Stories can be examined to determine the priority and need for various aspects of Shipping


## Related topics

- [Shippo API Integration Guide](/partner-integration/intro.md)