This section provides reference information about configuring and using the Content Delivery API.
Overview of the Content Delivery API
The GraphQL plugin includes a configurable Content Delivery API endpoint type. Without any additional development work, endpoints can be created in order to expose APIs for interacting with view models. The high level of configurability allows for quick and simple proof of concept tests. This endpoint type is not intended for production use because endpoints defined via project code are more consistent and easier to maintain in different environments. See Custom Content Delivery API development for more information on how to define a CDA endpoint via project code.
Configuring the Content Delivery API
- Click > Admin > APIs
Create a new GraphQL Delivery API:
- Name—used to differentiate API endpoints in the GraphQL CMS tool. It is also used to generate a default path for the API endpoint.
- Path—appended to
/graphql/management/to create the path where the API endpoint is available.
- Full Path (Read Only)—displays full path after applying logic for Path field.
- Query Entry View Classes—view models and interfaces used to generate the schema and expose GraphQL Query APIs.
- Mutation Entry View Classes—view models and interfaces used to generate the schema and expose GraphQL Mutation APIs.
Access—specifies entities that can access the API endpoint.
- API Key Required—an API key from one of the endpoint’s Clients is required for access to the endpoint (see Authentication).
Anyone—the API endpoint is open to any entity that can access one of the Paths that it is available at.
- Attributional Client (Optional)—The API Client that receives attribution for, and whose permissions are applied to, all requests made to this endpoint.
- CORS Configuration—configuration of allowed origins and headers for the API endpoint (see Cross-Origin Resource Sharing).
- Persisted Query Protocol—option to select a specific persisted query protocol implementation for the API endpoint (see Understanding persisted queries).
- Schema Locale—locale used during GraphQL schema documentation generation.
- Theme—provides theme fields, front-end fields, and/or image sizes for use via the API endpoint.
- Paths (Read Only)—all the paths the API endpoint is available at.
- Clients (Read Only)—API clients that have access to the API endpoint.
- Click Save in order to expose the endpoint.