Pages

16 October, 2024

Introducing Sitecore XM (Cloud) Apps REST API

While XM Cloud Deploy APIs are useful to manage Deploy Apps related activities, Sitecore XM Cloud team has released a new set of APIs to manage XM Cloud Apps. This newly introduced APIs can help us to manage the XM Apps collections, sites, analytics, and languages. The online API console released by Sitecore works more like a postman (like in OrderCloud API console) and enables us to use the browser to send the request the environment. 

In order to use this API, JWT token needs to be created. In order to do that, we need to create the automation client in Deploy App and then /oauth/token endpoint is used to get the JWT token along with client id and client secret. Please note that to create client credentials in Deploy App, we need to have Organization Admin or Organization Owner access to Cloud Portal. 

XM Apps API:

  • Sites
    • List sites
    • Create a site
    • Retrieve a site
    • Update a site
    • Delete a site
    • Duplicate a site
    • Rename a site
    • List sites that use an analytics identifier
    • Unassign analytics identifiers from sites
    • Retrieve the hierarchy of a site's main page
    • Retrieve the hierarchy of a page
    • List ancestors for a page
    • List children for a page
    • List hosts for a site
    • Create a site host
    • Retrieve a site host by host ID
    • Update a host by host ID
    • Delete a site host by host ID
    • List site templates
    • Upload a thumbnail for a site
  • Collections
    • List site collections
    • Create a site collection
    • Retrieve a site collection
    • Update a site collection
    • Delete a site collection
    • Rename a site collection
    • List sites in a site collection
  • Jobs
    • List site job statuses
    • Retrieve a job status
  • Languages
    • List languages
    • Add a language
    • List supported languages
    • Update a language
    • Delete a language

API Console Features:

  • Try it functionality to test the API via browser itself. 
  • Provides a request payload with explanation of each attributes.
  • Ability to set the environment variables
  • Ability to set the authorization token.
Try it here



No comments:

Post a Comment

blockquote { margin: 0; } blockquote p { padding: 15px; background: #eee; border-radius: 5px; } blockquote p::before { content: '\201C'; } blockquote p::after { content: '\201D'; }