Developer Hub » Generate and Manage API Keys

Link: https://support.brilliantdirectories.com/support/solutions/articles/12000088768

This article explains how to generate and manage API keys for authenticating requests to the Brilliant Directories API.

The API allows external applications to communicate securely with a Brilliant Directories website by sending requests to supported API endpoints. Each request must include a valid API key to authenticate the connection.

Important Notes

  • The API currently supports creating, retrieving, updating, and deleting member records.
  • Creating a member requires, at a minimum, an email address, a password (minimum of six characters), and a valid subscription_id (Membership Plan ID).
  • When a member is created through the API, the assigned Membership Plan settings are applied automatically, including any pre-selected top-level category and listing type, unless those values are overridden in the request.
  • The website's member limit is enforced for API requests, including sites using the 100,000 Member Boost.
  • If the allow_duplicate_member_emails Advanced Setting is disabled, duplicate member email addresses cannot be created through the API.
  • API requests are limited to 100 requests per minute.


How to Access the Tool


Navigate to Developer Hub > Generate API Key.




Generate an API Key


  1. Select Generate API Key
  2. Enter a descriptive name for the API key.
  3. Select Generate to create the API key. A unique API key is generated. Store the generated token in a secure location, as it cannot be viewed again after the dialog is closed.
  4. After generating the API key, refer to How to Connect Outside Applications Using the API: Google Sheets Example for an example of connecting an external application.

Configure API Key Permissions

Each API key can be configured with specific permissions to control which endpoints it can access.

Select Configure Permissions for the desired API key.

The available permission groups include:

  • Standard Endpoints
  • Advanced Endpoints
  • Sensitive Data

Enable only the permissions required for the intended integration, then select Save Permissions.






Disable or Delete an API Key


API keys are enabled by default when created. To temporarily prevent an API key from being used, disable it using the Enable API Key toggle.




If an API key is no longer needed, it can be permanently removed from the Actions menu.




Viewing the API Key Log


The API Key Log records every request made using an API key, making it easier to review activity and troubleshoot API requests.

To open the log, select Details for the desired API key.




The log displays every request processed with the selected API key.




Each request includes a Status value of either Success or Error. When a request fails, the Message field provides additional information about the error.

The log records the following request types:

  • Create – Records member creation requests.
  • Fields – Returns the available default member fields from the users_data table along with any custom member fields stored in the users_meta table. The available custom fields vary by website.
  • Verify – Confirms whether an API key is valid by sending a verification request.

Select Details for any log entry to view the complete request and response.




Create Requests

A Create request displays the information submitted when a member record is created through the API.




Fields Requests

A Fields request returns the default member fields available in the users_data table together with any custom member fields stored in the users_meta table.




Verify Requests

A Verify request confirms that an API key is valid.




Common Error Responses

The API may return different HTTP status codes when a request cannot be completed.

429 – Too Many Requests

Returned when the API request limit of 100 requests per minute has been exceeded.





400 – Bad Request

Returned when the request contains invalid or incomplete data, such as attempting to create a member after the website's maximum member limit has been reached.





405 – Method Not Allowed

Returned when an unsupported HTTP request method is used for the selected endpoint.