Skip to main content

Authorization

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

Hub Planner

Prerequisites​

To connect Nexla to Hub Planner, you need an active Hub Planner account with Administrator-level privileges or higher, and you must generate an API key from within your Hub Planner account settings.

Hub Planner Account Requirements​

  • A Hub Planner account with Administrator access or higher is required to generate API keys.

  • Hub Planner API access is available on all Hub Planner plans.

Generate a Hub Planner API Key​

Hub Planner uses API key authentication. To generate an API key for use with Nexla:

  1. Log in to your Hub Planner account.

  2. Click Settings in the top-right corner of the page.

  3. In the left navigation panel, under Integrations, click Hub Planner API.

  4. On the Hub Planner API page, click Enable API to activate API access for your account.

  5. Under the API Key Generator section, select the Role that the API key should be associated with. The role determines the level of access the key provides — select the role with the minimum permissions necessary for your integration.

  6. Click Generate Key to create the API key.

  7. Copy the generated API key and store it securely. Treat this key like a password — do not share it with untrusted parties or store it in plain text.

Hub Planner enforces a daily API rate limit of 6,000 API calls per account and a burst limit of 50 requests per 5 seconds. Plan your integration accordingly to avoid hitting these limits.

Important

The API key is displayed only once at the time of generation. Copy it immediately and store it in a secure location, such as a password manager. If you lose the key, you will need to generate a new one.

For additional information about Hub Planner API authentication, see the Hub Planner API FAQ and the Hub Planner API documentation on GitHub.

Create a Hub Planner Credential​

  • To create a new Hub Planner 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​

  1. Enter the Hub Planner API key you generated in the API Key field. This key authenticates all requests Nexla makes to the Hub Planner API on your behalf.

    Hub Planner's API authentication passes the API key directly in the Authorization header. Unlike standard Bearer token authentication, Hub Planner does not require the word "Bearer" before the key — Nexla handles this automatically based on the Hub Planner connector configuration.

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.