Skip to main content

Overview

To authenticate with the Ordinal API, you will need:
  1. API Key – A key that grants secure access to the Ordinal API, allowing authorized applications to interact with Ordinal.
This guide walks you through generating and copying your API Key in Ordinal.

Prerequisites

  • An Ordinal account on a Pro plan or higher
  • Access to workspace settings

Instructions

Step 1: Generating your API key

  1. Log in to your Ordinal workspace and navigate to the Ordinal API page.
  1. Click + Create an API Key and provide a descriptive name for the key.
  2. Copy the generated API Key immediately, as it is shown only once.

Step 2: Enter credentials in the Connect UI

Once you have your API Key:
  1. Open the form where you need to authenticate with Ordinal.
  2. Enter your API Key in the respective field.
  3. Submit the form, and you should be successfully authenticated.
You are now connected to Ordinal.