Skip to main content

Overview

To authenticate with Brilliant Directories, you need:
  1. Website Domain — the domain of your Brilliant Directories website.
  2. API Key — a key generated in your website’s Admin Panel.
This guide will show you how to get them.

Prerequisites

  • Access to your Brilliant Directories website’s Admin Panel.

Step 1: Find your website domain

Your website domain is the address of your Brilliant Directories website, for example www.yourdomain.com. Include www. if your site uses it, and leave out https:// and any trailing slash. If you have not connected your own domain yet, use the address shown on your website’s card on the Admin Panel Dashboard (for example launch12345.directoryup.com).

Step 2: Generate an API key

  1. Log in to your website’s Admin Panel and click Developer Hub in the left menu.
Brilliant Directories Admin Panel with Developer Hub in the left menu
  1. On the Manage API Keys card, click Manage API Keys.
Brilliant Directories Developer Hub page with the Manage API Keys button
  1. Click Generate API Key, enter an API Key nickname that says what the key is for, then click Generate API Key.
Brilliant Directories Generate API Key dialog with the API Key nickname field
  1. In the Save API Key – Only Shown Once window, click the copy button and store the key somewhere safe. It is shown only once: if you lose it, generate a new one.
Brilliant Directories Save API Key window with the copy button
  1. Optionally, click Configure Permissions to choose the endpoints the key can access. A new key starts with all Standard Endpoints enabled and all Advanced Endpoints disabled.

Step 3: Enter your credentials in the Connect UI

  1. Open the form where you need to authenticate with Brilliant Directories.
  2. Enter your website domain from Step 1 in the Website Domain field.
  3. Paste the API key you copied in Step 2 into the API Key field.
  4. Submit the form.
Brilliant Directories Connect UI form with the Website Domain and API Key fields