Skip to main content

Overview

To authenticate with Coassemble, you need:
  1. API Key — a Production or Test API key from your Coassemble workspace.
This guide will show you how to get it.

Prerequisites

  • A Coassemble workspace with API access. Build, Scale and Partner plans carry the full API, and developers can start a free Sandbox. The legacy Flow plan has no API access.
  • The Owner, Admin or Developer role in the workspace: only these roles see the Developer console.

Step 1: Create an API key

  1. Sign in to your Coassemble workspace.
  2. In the left sidebar, click Developer, then open the API keys tab.
  3. Click Create key.
Coassemble Developer page on the API keys tab with the Create key button highlighted
  1. Enter a Key name. Under Key type, choose Production (the default) for your live integration, or Test for building and testing. On a Sandbox workspace the dialog is called Create a test key and only creates Test keys.
  2. Click Create key.
Coassemble Create a test key dialog with a key name entered and the Create key button highlighted
  1. Copy the key straight away: it is shown only once. The key starts with COASSEMBLE: and already includes your workspace ID. Paste it whole, without adding Bearer.
Coassemble dialog showing the new test key with its copy button highlighted

Step 2: Enter your API key in the Connect UI

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