Before you start
Using the GraphQL Preview and Delivery APIs, you can deliver content to any app on any channel.
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):
{
"X-GQL-Token":"aEtSNzBsTaEtSNzBMA"
}
GraphQL IDE
You can send requests to the GraphQL server using GraphQL IDEs. There is an IDE for the Preview API and one for the Delivery API.
To help get you started, we have compiled several examples.