Skip to main content

Authorization

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

ShipBob

Prerequisites​

Before creating a ShipBob credential, you need to obtain your Personal Access Token (PAT) from your ShipBob account. ShipBob uses Personal Access Token authentication for all API requests, with the token sent in the Authorization header with the Bearer prefix.

To obtain your ShipBob Personal Access Token, follow these steps:

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

  2. Navigate to your account settings or API management section in the ShipBob interface.

  3. Look for the API or Personal Access Tokens section in your account settings, or navigate to Settings > API or Account > API.

  4. If you don't have a Personal Access Token yet, look for the option to generate or create your Personal Access Token.

  5. Click Create Personal Access Token or Generate PAT to create a new Personal Access Token.

  6. Configure your Personal Access Token settings:

    • Enter a name for the token (e.g., "Nexla Integration")
    • Review and select the permissions or scopes for the token (if applicable)

  7. Click Create or Generate to create the Personal Access Token.

  8. Copy the Personal Access Token immediately after it's generated, as it may not be accessible again after you navigate away from the page.

  9. Store the Personal Access Token securely, as you will need it to configure your Nexla credential. The Personal Access Token is sensitive information and should be kept confidential.

The Personal Access Token is sent in the Authorization: Bearer {token} header for all API requests to the ShipBob API. The token authenticates your requests and grants access to ShipBob resources based on your account permissions. If your Personal Access Token is compromised, you should immediately revoke it in your ShipBob account settings and generate a new one. For detailed information about obtaining Personal Access Tokens, API authentication, and available endpoints, refer to the ShipBob API documentation.

Create a ShipBob Credential​

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

New Credential Overlay – ShipBob API

ShipBobCred.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.

Personal Access Token Authentication​

ShipBob uses Personal Access Token authentication for all API requests. The Personal Access Token is sent in the Authorization header with the Bearer prefix to authenticate API requests to the ShipBob API.

  1. Enter your ShipBob Personal Access Token (PAT) in the ShipBob Personal Access Token (PAT) field. This is the Personal Access Token you obtained from your ShipBob account settings (Settings > API or Account > API). The Personal Access Token is sent in the Authorization: Bearer {token} header for all API requests to the ShipBob API. The Personal Access Token is sensitive information and must be kept confidential.

    Your ShipBob Personal Access Token can be found in your ShipBob account settings under Settings > API or Account > API. The Personal Access Token is sent in the Authorization: Bearer {token} header for all API requests to the ShipBob API.

    If your Personal Access Token is compromised, you should immediately revoke it in your ShipBob account settings and generate a new one. The Personal Access Token provides access to your ShipBob account data and should be treated as sensitive information. Keep your Personal Access Token secure and do not share it publicly.

    For detailed information about creating and managing Personal Access Tokens, API authentication, and available endpoints, see the ShipBob 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.