Generate ShipEngine API Keys

In the ShipEngine interface, you can generate API keys for use in your application or the sandbox environment.

In this article, we give a brief overview of the following features to help you get started:

  • Accessing the sandbox and generating sandbox API keys.

  • Generating your production API keys.

ShipEngine Sandbox

ShipEngine accounts can access a Sandbox environment. Here, you can manage your test API keys and view the provided Sandbox carriers and their corresponding carrier_id.

To enable the Sandbox environment, go to the Environment drop-down and select Sandbox.

Full-screen view of the ShipEngine Sandbox dashboard, with Sandbox environment selected

To generate new Sandbox API Keys:

  1. Click API Keys from the navigation:

    NAV_SetUp-APIKeysMRK.png
  2. Click Create new key:

    Setup_APIKeys-CreateNewKeyBTN.png
  3. Name the new API key and hit Enter to generate a key:

    Setup_APIKeys-APIKeyName.png

A new Sandbox key will populate. Click the Copy icon to copy the key.

Setup_APIKeys-CopyAPIKey.png

Sandbox API Keys

The Sandbox API Keys will all begin with TEST and can only be used with the provided sandbox carriers.

Generate Production Keys

To enable the Production environment, go to the Environment drop-down and select Production.

In the API Keys section, you will find your production API keys that can be used to integrate with your live carriers and marketplaces.

DASH_Production-FullScreenMRK.png
  1. Click API Keys from the navigation:

    NAV_SetUp-APIKeysMRK.png
  2. Click Create new key:

    Setup_APIKeys-CreateNewKeyBTN.png
  3. Name the new API key and hit Enter to generate a key:

    Setup_APIKeys-APIKeyName.png