Skip to main content

Overview

To authenticate with Chartly, you need:
  1. API Key — a Chartly API key.
This guide will show you how to get it.

Prerequisites

  • A Chartly account. Sign up for free if you don’t have one.

Step 1: Create an API key

  1. Log in to the Chartly Dashboard. In the API keys section, click Create key.
Chartly Dashboard with the Create key button in the API keys section highlighted
  1. Enter a Label for the key and click Create key.
Chartly Create API key dialog with a label entered and the Create key button highlighted
  1. Click Copy to copy the key, then click I’ve saved it. Chartly shows the key only once.
Chartly Save your key dialog with the Copy button highlighted
To try Chartly without an account, get a trial API key (it starts with trial_) from Chartly’s trial endpoint:
Use the api_key value from the response. Trial keys have limited usage and are meant for testing.

Step 2: Enter your API key in the Connect UI

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