AfterShip

Prerequisites

• An active AfterShip account from which data is to be ingested exists.

• The API key is available to authenticate Hevo on your AfterShip account.

• You are logged in as an Admin user in AfterShip to create the API key.

• You are assigned the Team Administrator, Team Collaborator, or Pipeline Administrator role in Hevo to create the Pipeline.

Creating the API Key

You require an API key to authenticate Hevo on your AfterShip account. The API key does not expire and can be reused for all your Pipelines.

Note: You must log in as an Admin user to perform these steps.

To create the API key:

1. Log in to your AfterShip account.

2. In the bottom left corner of the page, click Settings.

   

3. On the Settings page, click API keys.

   

4. On the API keys page, click Create API key.

   

5. On the Create new API key page, do the following:

   1. Specify the API Name, not exceeding 50 characters.

      

   2. In the Select signature header section, select API key.

      

   3. In the Select admin API permissions section, specify the required levels of permission for different parts of your Tracking account.

      

      Refer to the following table for the required permissions:

      Field Name	Permission
      Carriers	Read
      Estimated delivery dates	None
      Last checkpoints	None
      Notifications	None
      Trackings	Read

   4. Click Save.

6. Click the Copy icon corresponding to the API key to copy it, and save it securely like any other password. Alternatively, you can Download the key. Use this key while configuring your Hevo Pipeline.

   

Configuring AfterShip as a Source

Perform the following steps to configure AfterShip as the Source in your Pipeline:

1. Click PIPELINES in the Navigation Bar.

2. Click + CREATE PIPELINE in the Pipelines List View.

3. On the Select Source Type page, select AfterShip.

4. On the Configure your AfterShip Source page, specify the following:

   

   • Pipeline Name: A unique name for the Pipeline, not exceeding 255 characters.

   • API Key: The API key that you obtained from your AfterShip account.

5. Click TEST & CONTINUE.

6. Proceed to configuring the data ingestion and setting up the Destination.