Skip to main content

Authorization

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

Freightview

Prerequisites​

To connect Nexla to Freightview, you need an active Freightview account and an API key. Freightview's API uses HTTP Basic Authentication, where the API key serves as the username and the password field is left empty. The API is available at https://www.freightview.com/api/v1.0/.

Freightview offers two API keys per account: an Account API key and a secondary key. The Nexla connector uses the Account API key for authentication. For additional information about Freightview's API, see the Freightview Developer Documentation.

Obtain a Freightview API Key​

Freightview API keys are managed from within your Freightview account settings. To locate your API key:

  1. Sign in to your Freightview account at freightview.com.

  2. Click your username (or name) in the top-right corner of the screen to open the account menu.

  3. On the account page, locate the Account Settings sidebar on the left side and click API Keys (also referred to as Api Integration in some versions of the interface).

  4. You will see two API keys listed. Copy the key labeled Account API key — this is the key required for Nexla integration.

Important

Treat your API key like a password. Do not share it publicly, store it in source code, or expose it in client-facing applications. If your key is ever compromised, return to this page and regenerate it immediately.

For step-by-step guidance on locating your API key, see the How to Get Your Freightview API Key guide on the Freightview blog.

Create a Freightview Credential​

  • To create a new Freightview 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 Settings​

  1. Enter your Freightview Account API key in the API Key field. Nexla will use this key as the username in HTTP Basic Authentication headers when making requests to the Freightview API. No password is required — the Freightview API expects the key as the username with an empty password.

    The API key is transmitted securely and stored encrypted within Nexla. Freightview's API authenticates requests using the HTTP Basic Auth standard, with the API key in the username position and no value in the password position.

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.