Skip to main content

Authorization

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

ShipStation

Prerequisites​

Before creating a ShipStation credential, you need to obtain your API Key and API Secret from your ShipStation account. ShipStation uses Basic Authentication for all API requests, with the API Key as the username and the API Secret as the password.

To obtain your ShipStation API credentials, follow these steps:

  1. Sign in to your ShipStation account using your administrator credentials.

  2. Navigate to Settings in your ShipStation account by clicking the gear icon in the top right corner.

  3. In the Settings menu, click API Settings or navigate to Settings > API Settings.

  4. Your API Key will be displayed as the username in the API Settings page. Copy the API Key.

  5. Your API Secret will be displayed in the API Settings page. Copy the API Secret immediately, as it may not be accessible again after you navigate away from the page.

  6. Store both credentials securely, as you will need them to configure your Nexla credential. The API Key and API Secret are sensitive information and should be kept confidential.

The API Key and API Secret are used for Basic Authentication in all API requests to the ShipStation API. The API Key is used as the username and the API Secret is used as the password in the Basic Authentication header. If your credentials are compromised, you should immediately revoke them in your ShipStation account settings and generate new ones. For detailed information about obtaining API credentials, API authentication, and available endpoints, refer to the ShipStation API documentation.

Create a ShipStation Credential​

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

New Credential Overlay – ShipStation API

ShipStationCred.png

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 provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Basic Authentication​

ShipStation uses Basic Authentication for all API requests. The API Key is used as the username and the API Secret is used as the password in the Basic Authentication header.

  1. Enter your ShipStation API Key in the API Key field. This is the API Key you obtained from your ShipStation account settings (Settings > API Settings). The API Key is used as the username in Basic Authentication for all API requests to the ShipStation API.

  2. Enter your ShipStation API Secret in the API Secret field. This is the API Secret you obtained from your ShipStation account settings. The API Secret is used as the password in Basic Authentication for all API requests to the ShipStation API. The API Secret is sensitive information and must be kept confidential.

    Your ShipStation API credentials can be found in your ShipStation account settings under Settings > API Settings. The API Key is used as the username and the API Secret is used as the password in Basic Authentication for all API requests to the ShipStation API.

    If your API credentials are compromised, you should immediately revoke them in your ShipStation account settings and generate new ones. The API Key and API Secret provide access to your ShipStation account data and should be treated as sensitive information. Keep your credentials secure and do not share them publicly.

    For detailed information about obtaining API credentials, API authentication, and available endpoints, see the ShipStation API documentation.

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.