Before you start

Using the GraphQL Preview and Delivery APIs, you can deliver content to any app on any channel.

Tip

For an overview of GraphQL concepts, see Introduction to GraphQL.

Authentication

You must authenticate with an API key. The key must be included in HTTP requests as an HTTP header with the name X-GQL-Token. To obtain an API key, use either the:

After you obtain a key, in the Integrated Development Environment (IDE), on the HTTP HEADERS tab, add the API key using the following format (replacing the example API key):

RequestResponse

{
    "X-GQL-Token":"aEtSNzBsTaEtSNzBMA"
}

GraphQL IDE

You can send requests to the GraphQL server using GraphQL IDEs. To query your content, you can access the GraphQL IDE at the following address:

RequestResponse

https://{SITECORE_INSTANCE}/api/graphql/ide

Tip

To help get you started, we have compiled several examples.

Do you have some feedback for us?

If you have suggestions for improving this article,