Brightspot Integrations Guide
Brightspot Integrations Guide
Built-in integrations

Configuring the Zephr Content API

This section describes how to configure the Zephr Content API in Brightspot. This API allows Zephr to retrieve additional data about content published in Brightspot.

To configure the Zephr Content API:

  1. Click menu > APIs.
  2. Configure an API endpoint by doing the following:
    1. From the Create list, select Zephr Content API, and then click New.
    2. In the Name field, enter an identifying name for this API.
    3. In the Path field, either leave blank to use the default path, or enter a custom path if desired.
    4. Click Save.
  3. Configure an API client by doing the following:
    1. In the Clients widget, click New API Client.
      New Zephr client New Zephr client
      New Zephr client
    2. In the Name field, enter an identifying name for this endpoint.
    3. Under Endpoints, click add_circle_outline, and select the endpoint you configured in step 2.
    4. Under Permissions, click add_circle_outline.
    5. Under Sites, click add_circle_outline, and select a site to which Zephr entitlements applies. Repeat to add additional sites.
    6. Copy the values for Client ID and API Key to a text editor. You will paste these values into your Zephr console (see step 5, below).
  4. Click Save.
  5. In your Zephr console, configure the content API to make calls to the Brightspot API by doing the following:
    1. Set the URL template to https://CMS_DOMAIN/api/zephr/PATH?path={{path}}&site={{site-slug}}, replacing CMS_DOMAIN and PATH with the correct values for your configuration.
    2. Set the headers X-Client-Id and X-Client-Secret to the values for Client ID and API Key you copied in step 3f.
Previous Topic
Configuring Zephr
Next Topic
Configuring a paywall for a content type
Was this topic helpful?
Thanks for your feedback.
Our robust, flexible Design System provides hundreds of pre-built components you can use to build the presentation layer of your dreams.

Asset types
Module types
Page types
Brightspot is packaged with content types that get you up and running in a matter of days, including assets, modules and landing pages.

Content types
Landing pages
Everything you need to know when creating, managing, and administering content within Brightspot CMS.

Admin configurations
A guide for installing, supporting, extending, modifying and administering code on the Brightspot platform.

Field types
Content modeling
Rich-text elements
A guide to configuring Brightspot's library of integrations, including pre-built options and developer-configured extensions.

Google Analytics
Apple News