Skip to main content

Overview

To authenticate with Endorsal, you need:
  1. API Key — an API key for one of your Endorsal properties.
This guide will show you how to generate it.

Prerequisites

  • An Endorsal account. If you don’t have one, sign up. New accounts start with a 14-day free trial, and the number of monthly Public API calls depends on your plan.

Step 1: Generate an API key

  1. Log in to Endorsal.
  2. Click Integrations in the left sidebar, then click the Public API card.
Endorsal Integrations page with the Public API card highlighted
  1. On the API page, under Select a property, choose the property you want to connect. Each API key belongs to one property.
  2. Click Generate new key.
Endorsal API page with a property selected and the Generate new key button
  1. Your new key shows up in the API keys table. If you like, give it a name, then click the copy icon in the Actions column to copy the key.
Endorsal API keys table with the new key and the copy icon in the Actions column You can invalidate a key at any time by clicking its Invalidate (thumbs down) icon.

Step 2: Enter your API key in the Connect UI

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