Frontend API

The Frontend API is a GraphQL API that provides an interface to manage your Frontend CMS content and publish your site. Using the API you can:

  • List Content Groups
  • Create New Content Groups
  • Import entries into Content Groups
  • Import media
  • Publish your Frontend site

The Frontend API is available at:

URL

Environment

POST https://api.getshogun.com/frontend

Production

POST https://api.shogun.dev/frontend

Staging

For information on how to authenticate - including where to find your API key and site ID - refer to Authenticating with the Frontend API.

Rate Limiting

Calls to the Frontend API are rate-limited. You will receive an HTTP 429 Too Many Requests response status if your rate exceeds 1000 calls per minute.

Rate Limits on Publish Operations

Only one publish operation can run at once for a site. Even if you are within the Frontend API rate limits, you will receive an error if you initiate a publish operation for a site while another publish is still in progress for the same site.

🚧

Only one publish operation can run at once for a site. That includes publish operations that were initiated by both the Frontend XM and the Frontend API.

GraphQL Query Editor

The GraphQL editor offers a way to explore and try out the Frontend API without writing code. To access the GraphQL query editor:

  1. Log in to the Developer Portal.
  2. Select the 'TRY NOW' button.
  3. Add your authentication credentials (API key, site ID) to the GraphQL query editor's HTTP Headers in JSON format. For example:

Frontend API Reference Documentation

The Frontend API reference documentation is embedded in the GraphQL query editor in the Developer Portal. The API reference documentation includes:

  • the operations (i.e. mutations and queries) that are available in the Frontend API
  • the data schemas and required properties for the operations

To access the Frontend API reference documentation:

  1. Log in to the Developer Portal.
  2. From your account, select the Dashboard menu item from the dropdown. For example:
  1. Select the 'API Reference' tile.
  2. Add your authentication credentials (API key, site ID) to the GraphQL query editor's HTTP Headers in JSON format.
  3. On the right-hand side of the GraphQL query editor, click on the DOCS or SCHEMA tab to access the API reference documentation.

Did this page help you?