Oracle Content Management SDKs

Content SDK

The Content SDK for Oracle Content Management is a light-weight JavaScript wrapper that interacts with the Content REST APIs.

This read-only SDK retrieves structured content, digital assets, and content layouts that are managed in Oracle Content Management. The SDK can be used in web browsers or NodeJS projects.

The Content SDK consists of three main modules:

ContentSDK: The main entry-point object. The ContentSDK object lets you create client objects to access content based on your requirements.
ContentDeliveryClient : A client object that is set up to access published content items and digital assets.
ContentPreviewClient : A client object that is set up to access content types, draft content items, and draft digital assets.

The Content SDK is made available as an Oracle open-source project on GitHub:

https://github.com/oracle/content-management-sdk

It can be installed via the NPM package manager:

npm install @oracle/content-management-sdk

Detailed descriptions of the ContentSDK, ContentDeliveryClient, and ContentPreviewClient classes are available at Content SDK.

Mobile SDKs

The Mobile SDKs for Oracle Content Management are read-only SDKs for retrieving published content items, digital assets, and content layouts that are managed in Oracle Content Management.

The Mobile SDKs are light-weight iOS and Android bindings that interact with the REST API for Content Delivery. These SDKs can easily be integrated with any third-party iOS or Android mobile application. The Mobile SDKs let you fetch content from the server on the fly, without the need for rebuilding the app to modify content. The SDKs also provide a wide range of advanced utilities and features such as response caching, a search request builder, and request/response modeling.

You can download the SDKs for iOS and Android on the Oracle Content Management downloads page. Each SDK includes a readme file that provides instructions on how to use the SDK in your projects.

Mobile SDK downloads are here:

https://www.oracle.com/middleware/technologies/content-experience-downloads.html

Sites SDK

The Oracle Content Management JavaScript SDK (Sites SDK) has a set of functions that enable components to have a more integrated experience with Oracle Content Management.

The Sites SDK is available for download from the Oracle Content Management server:

http://{server}/_sitesclouddelivery/renderer/app/sdk/js/sites.min.js

The main purpose of the Sites SDK is to enable users to build and manage applications. It provides several features:

Communication across inline frame and domain boundaries
- Enables a component to communicate with a page regardless of where the component is hosted
- Includes participation in the page model life cycle:
  - creating the component
  - rendering the component with stored properties
  - updating the component and saving those changes
  - deleting the component from the page
- Stores and retrieves custom settings used to configure a component for use in a page
- Uses intercomponent communication to take part in triggers and actions
Geometry hints to a page (doesn’t apply to custom components)
- Enables a page to dynamically resize the inline frame when told to do so by a component
- Results in a component appearing to be part of a page, and the page moving in response to component resize events (no scroll bars)
Component awareness of when it is called by Oracle Content Management
- Communication between a component and a page contains a token signed by a private key.
- Sites SDK enables a component to decode the token and facilitate verification of the caller.

You include Sites SDK functions by providing a known path of the script. For example:

<script
      type="text/javascript"
    src="<sdk_install_dir_path_prefix>/sites.min.js"></script>

See Sites SDK Reference for further details.