logo
logo

OpenAPI

The OpenAPI feature allows you to integrate Sitecore Content Hub™ with third-party services, such as Box, Gmail, Salesforce, and Twitter.

OpenAPI has predictable resource-oriented URLs. It returns JSON-encoded responses and uses standard HTTP response codes, authentication, and verbs.

With OpenAPI, you can describe your entire API, including:

  • The available endpoints (for example /M.Asset) and the operations on each endpoint (for example, GET /M.Asset or POST /M.Asset).
  • Operation parameters, with input and output for each operation.
  • Authentication methods.
  • Contact information, license, terms of use, and other information.

Learn more:

Warning

OpenAPI is a preview feature. To enable the full feature, contact your Content Hub account manager.

Documentation API

The documentation API:

  • Is a public resource with no authorization required. It encompasses the documentation API and the resource view API.
  • Serves a standard OpenAPI document that can be read and interpreted by OpenAPI tools, such as Swagger UI.
  • Describes endpoints, operations, request-response schema, HTTP schemes, and security schemes hosted by the domain configured in Content Hub.

The endpoint signature of the documentation API is:

/openapi/{openapi_version_integer}/{domain_identifier}/{optional:specification_version}

For example:

https://stylelabs.com/openapi/v3/FruitfulContent

Resource view API

The resource view API:

  • Is the API that serves actual data required by business/external integration.
  • Requires authorization.

The ResourceView is obtained by applying domain specifications to a specific entity.

The endpoint signature is:

/api/resourceViews/{domain_identifier}/{optional:specification_version}/{resourceView_identifier}/{entityId}

For example:

https://stylelabs.com/api/resourceViews/FruitfulContent/FruitfulContentView/30652

Can we improve this article ? Provide feedback