Skip to main content

Authorization

Follow this guide to create a new EasyPost credential that will allow Nexla to authenticate to and exchange data with your EasyPost account.
easypost_api_auth.png

EasyPost

Prerequisites​

EasyPost uses HTTP Basic Authentication with an API key as the username and a blank password. Before creating a credential in Nexla, you will need an active EasyPost account and an API key.

Obtain an EasyPost API Key​

EasyPost provides two types of API keys: Test keys, which allow you to explore and test the API at no cost, and Production keys, which are used for live shipping operations. Both key types are available immediately after account creation.

  1. Sign in to your EasyPost account at https://www.easypost.com/login.

  2. Click on your account name or avatar in the top-right corner to open the account menu, and select Account Settings.

  3. In the Account Settings page, navigate to the API Keys tab.

  4. Your Test and Production API keys are displayed on this page. Copy the key you want to use with Nexla.

    Use your Test API key during initial setup and integration testing. Switch to your Production API key only when you are ready to process live shipments. Test mode transactions do not result in real labels or charges.

  5. To generate an additional API key, click the Add Additional API Key button and select either Production or Test from the dropdown menu.

Important

Treat your EasyPost API key with the same level of security as a password. Anyone with access to your key can perform actions on your EasyPost account, including purchasing labels. If you believe a key has been compromised, you can immediately disable it from the API Keys page in your EasyPost Dashboard.

For additional information about API key management, refer to the EasyPost Authentication documentation.

Create an EasyPost Credential​

  • To create a new EasyPost credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used to provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

API Key Authentication​

EasyPost credentials in Nexla use HTTP Basic Authentication, which transmits the API key as the username via the Authorization: Basic header. No password is required—the password field is left blank automatically.

  1. Enter your EasyPost API key in the API Key field. This is the key you copied from the API Keys tab in your EasyPost Account Settings. The key authenticates all requests made by Nexla to the EasyPost API on your behalf.

  2. The Base URL field is pre-populated with the standard EasyPost API base URL: https://api.easypost.com/v2. This value should be used for both Test and Production API keys—EasyPost uses the same base URL for both environments; the key type determines which environment is active.

    The Base URL should not be changed unless EasyPost has specifically directed you to use a different endpoint, such as for regional or enterprise configurations.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.