Skip to main content

Authorization

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

Beamer

Prerequisites​

The Beamer REST API uses API key authentication. Every request to the Beamer API must include your account's API key in the Beamer-Api-Key HTTP header — unauthenticated requests are rejected. Before creating a credential in Nexla, retrieve the API key from your Beamer account.

Retrieve Your Beamer API Key​

  1. Sign in to your Beamer account at app.getbeamer.com.

  2. Click the gear icon (Settings) in the bottom-left corner of the Beamer dashboard, or navigate directly to app.getbeamer.com/settings#api.

  3. Select API from the left-hand settings menu. Beamer displays your account's API key in this section.

  4. Copy the API Key value, and store it securely. This key grants full access to your Beamer account data, so it should be treated like a password.

    If your API key has been exposed or you want to rotate it, use the rotate option in the API settings section. Rotating the key invalidates the previous value, so any existing integrations using the old key will need to be updated.

For complete information about the Beamer API and its authentication model, see the Beamer API documentation.

Important

The Beamer API key grants full access to your account data and the ability to create, update, or delete posts and feature requests. Store it in a secure secret manager, never commit it to source control, and rotate it immediately if you suspect it has been exposed.

Rate Limits​

The Beamer API enforces a rate limit of 30 requests per second for paid accounts, in addition to monthly request limits that vary by plan. When configuring Nexla data flows that fan out to many Beamer endpoints (for example, listing posts and then fetching reactions or feedbacks per post), consider these limits when sizing batches and scheduling cadence.

Create a Beamer Credential​

  • To create a new Beamer 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.

Authentication Settings​

  1. Enter your Beamer API Key in the API Key field. This is the value copied from the API section of the Beamer settings page. Nexla will automatically send this value in the Beamer-Api-Key header on every API call made with this credential.

    The API Key is stored as a secret in Nexla. It is never displayed back after saving and cannot be retrieved — only re-entered or rotated.

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. Nexla validates the credential by issuing a test request to the Beamer API; a failed validation indicates the key is invalid, has been rotated, or lacks access to the account.

  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.