CMS API (trial)

🚧

The CMS API is in Beta Trial

Throughout Q1, support for this service is limited and not recommended for production usage. The beta trial is expected to end in Q1 2022.

The CMS API provides an interface to manage your Frontend CMS content: Content Groups, Content Items, and Fields. A CMS API is available for both production and staging environments. The API is available at:

Authenticating with the API

To authenticate with the CMS API, provide the following headers with each call:

Header

Value

Example

Authorization

Frontend Token

Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZC

SiteID

Frontend SiteID

SiteID: f586b963-4bfe-4ebe-b35340ihj

apiKey

CMS API Key

apiKey: fhgfhBxb989hjghYDRg4beVl

For more information on how to authenticate - including where to find your Frontend token and SiteID - refer to the Developer Portal documentation.

Rate Limiting

Calls to the CMS API are rate-limited. You will receive an HTTP 429 Too Many Requests response status if your rate exceeds 1000 calls per minute. Inspect your response headers to monitor your usage and remaining limit:

If you need your rate limit adjusted during the beta trial, contact [email protected].

GraphQL Query Editor

The GraphQL editor offers a way to explore and try out the CMS API without writing code.

A query editor is available for both production and staging environments. To access the query editor:

  1. Navigate to https://api.frontend.getshogun.com/playground.
  2. Enter the API URL in the query editor:

For example:

  1. Add your store’s Authorization token, Site ID, and API key to the query editor’s HTTP Headers in JSON format. For example:

CMS Data Models

The CMS schema is available in the SCHEMA tab on the right-hand side of the query editor.

Documentation for the data models is available in the DOCS tab on the right-hand side of the query editor.

Use Case - Importing CMS Content

The CMS API allows developers to manage their Frontend content. Refer to the section Importing Blog Content in the Developer Portal documentation for an example of using the CMS API to import content.

Getting Help

Contact [email protected] for help with the CMS API or the Developer Portal during the beta trial.


Did this page help you?