Skip to main content

Authorization

Follow this guide to create a new Heroku PostgreSQL credential that will allow Nexla to authenticate to and exchange data with your Heroku account via the Heroku Platform API.
heroku_postgresql_api_auth.png

Heroku PostgreSQL

Prerequisites​

Before creating a Heroku PostgreSQL credential, you'll need to obtain a Heroku API token from your Heroku account. The Heroku Platform API uses bearer token authentication, and the API token is used to authenticate all API requests.

To obtain a Heroku API token:

  1. Log in to your Heroku account at https://dashboard.heroku.com or use the Heroku CLI.

  2. Navigate to your account settings. You can access this by clicking on your account name in the top right corner of the Heroku dashboard and selecting Account Settings, or by visiting https://dashboard.heroku.com/account.

  3. In the Account Settings page, scroll down to the API Key section.

  4. Click Reveal or Show next to the API Key field to display your existing API token, or click Generate New API Key if you need to create a new one.

  5. Copy the API token immediately after it's displayed. The token is a long string of characters that will be used as a Bearer token in API requests.

  6. Store the API token securely, as it provides full access to your Heroku account via the Platform API.

Alternatively, you can also obtain your API token using the Heroku CLI by running the command heroku auth:token in your terminal. This will display your current API token.

For detailed information about Heroku API authentication and token management, refer to the Heroku Platform API Documentation and Heroku API Authentication Guide.

Create a Heroku PostgreSQL Credential​

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

New Credential Overlay – Heroku PostgreSQL

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

Authentication Settings​

  1. In the Heroku API Token field, enter the Heroku API token that you obtained from your Heroku account settings. This token is used as a Bearer token in the Authorization header for all Heroku Platform API requests.

    The Heroku API token is sensitive information and provides full access to your Heroku account via the Platform API. Keep it secure and do not share it publicly. If you suspect your token has been compromised, regenerate it immediately in your Heroku account settings.

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.