Connecting to Bannerbear

Bannerbear uses API Keys to control access to the API. The API supports different key types with varying levels of access.

Using API Key Authentication

You can obtain your API keys from the Bannerbear dashboard. Different key types are available depending on your access requirements.

After setting the following connection properties, you are ready to connect:

AuthScheme: Set this to APIKey.
APIKey: Set this to your Bannerbear API key.
KeyType: Set this to specify your API key type (required).
ProjectId: Required when KeyType is set to Master for accessing project-specific endpoints.

Key Type Configuration

The KeyType property determines the scope and access level of your API key:

Project: Provide access to endpoints within a specific project
Master: Provide account-wide access to all projects and endpoints

When using a Master key type, you must specify the ProjectId to access project-specific endpoints. The ProjectId parameter allows Master keys to operate on specific projects while maintaining their elevated access privileges.

Example connection strings:

Standard API Key Configuration:

Profile=C:\profiles\Bannerbear.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;KeyType=Project';

Master Key Configuration with ProjectId:

Profile=C:\profiles\Bannerbear.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_master_api_key;KeyType=Master;ProjectId=your_project_id';

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

Property	Description
APIKey	The API Key used to authenticate to Bannerbear.
AuthScheme	The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT
KeyType	The type of API key being used for authentication. Accepted entries are Project or Master. Allowed values are: PROJECT, MASTER
ProjectId	The project identifier required when using a Master API key for non-Projects endpoints.