Sitecore Authoring and Management Using GraphQL API

The Sitecore Authoring and Management API provides a single endpoint and schema that allows you to manage your Sitecore content using GraphQL. This is a new feature that was introduced in Sitecore 10.3. You can use the API to perform tasks previously possible only through the Sitecore user interface.

You can use the following endpoint for Authoring and Management:

https://www.sample.com/sitecore/api/authoring/graphql/v1/

You can explore the Authoring and Management APIs with an interactive browser-based GraphQL IDE. (You need to enable the GraphQL IDE by adding the following setting to the config file using the Sitecore patch file <setting name="GraphQL.Enabled" value="true"></setting> <setting name="GraphQL.ExposePlayground" value="true"></setting>)

this is not recommended for the production environment

https://www.sample.com/sitecore/api/authoring/graphql/playground/

You can perform authoring operations using queries and mutations for the following GraphQL types:

• Item
• Media
• Search
• Site
• Template

 

Examples

• Create an item

You can create an item with the create Item mutation.


• Delete an item

You can delete an Item using the delete item mutation. You can specify the item ID or path.


• Upload media

You can use the upload Media mutation to get a pre-signed upload URL. You use the pre-signed upload URL to upload a media file to Sitecore.


• Trigger an index rebuild

You can use the rebuild Indexes mutation to run an index rebuilding operation.


• Get the configured site

You can query information about a specific site by its name.

You can use the following URL to see the full list of operations.

https://doc.sitecore.com/xp/en/developers/103/sitecore-experience-manager/query-examples-for-management-operations.html

Conclusion

Carefully following these steps would enable you to make good use of Sitecore’s Authoring and Management API that allows for the extension of Experience Manager (XM) with custom dialogs and user interfaces.

Since the API is read/write flexible and is safe to upgrade, one can simply do away with the complexities of implementing in-process customizations which are arguably very difficult to execute with subsequent XM upgrades.

Reach out to us for any concerns or queries around Sitecore’s Authoring and Management APIs and be sure to receive nuanced and personalized guidance and implementation assistance from our team of Sitecore experts.