Skip to main content

Overview

To authenticate with Bannerbear, you need:
  1. API Key — a V5 API key of your Bannerbear workspace.
This guide will show you how to create one.

Prerequisites

  • A Bannerbear account. The free trial includes API access. If you don’t have an account, start a free trial.

Step 1: Create a V5 API key

  1. Sign in to the Bannerbear dashboard.
  2. In the sidebar, under Developers, click API Keys.
Bannerbear dashboard sidebar with API Keys under Developers
  1. On the API Keys page, click Create API Key.
Bannerbear API Keys page with the Create API Key button
  1. Enter a name (for example, nango-integration). Under Permissions, tick the Read and Write boxes for the resources your app needs, or leave every box unticked to give the key full access. Leave Allowed Origins blank, then click Create API Key.
Bannerbear Create API Key form with the name, permissions and allowed origins fields
  1. In the API Keys list, click Copy next to the new key.
Bannerbear API Keys list showing the new key with its Copy button

Step 2: Enter your API key in the Connect UI

  1. Open the form where you need to authenticate with Bannerbear.
  2. Enter your V5 API key in the API Key field.
  3. Submit the form, and you should be successfully authenticated.
Bannerbear Connect UI form with the API Key field You are now connected to Bannerbear.