Jump to main content
Help Center
HCL TECHNOLOGIES
ABOUT US
PRODUCTS & SOLUTIONS
RESOURCES
CONTACT US
HCL Connections Docs Documentation
Deploying IBM Connections Docs 2.0 CR3
Using IBM Connections Docs 2.0 CR3
API Reference
Search
Home
API Reference
APIs are available for developers who are creating applications that integrate social capabilities, features, and functionality. Most APIs use the Open Authorization (OAuth) protocol for authentication and authorization. OAuth is a protocol that provides a way for a third-party application to interact with an API on a user's behalf without knowing the user's authentication credentials.
REST APIs
IBM Docs provides REST APIs, allowing developers to create third-party applications that integrate editing and viewing capabilities.
Editor Application APIs
This topic provides Editor Application APIs and examples for
IBM Docs
.
API Reference
APIs are available for developers who are creating applications that integrate social capabilities, features, and functionality. Most APIs use the Open Authorization (OAuth) protocol for authentication and authorization. OAuth is a protocol that provides a way for a third-party application to interact with an API on a user's behalf without knowing the user's authentication credentials.
IBM Docs JavaScript API
In order to integrate IBM Docs with third-party systems, a solution has been implemented to enable browser-side integration by releasing one IBM Docs JavaScript SDK and making some public JavaScript APIs available.
REST APIs
IBM Docs provides REST APIs, allowing developers to create third-party applications that integrate editing and viewing capabilities.
Editor Application APIs
This topic provides Editor Application APIs and examples for
IBM Docs
.
Retrieving document information
You can retrieve document information such as document type and size supported by
IBM Docs
in JSON format by the editor application API.
Opening a document in third-party integrations
In third-party integrations, you can open a document in
IBM Docs
by the editor application API.
Retrieving the document status
You can get the document status by the Editor Application API.
Viewer Application APIs
This topic provides Viewer Application APIs and examples for
IBM Docs
.
Developing with third-party integration APIs
Learn how to develop with third-party integration APIs in IBM Docs. For more information about required APIs with third-party integration, go to
APIs for integrating with other repositories
.
Editor Application APIs
This topic provides Editor Application APIs and examples for
IBM Docs
.
Retrieving document information
You can retrieve document information such as document type and size supported by
IBM Docs
in JSON format by the editor application API.
Opening a document in third-party integrations
In third-party integrations, you can open a document in
IBM Docs
by the editor application API.
Retrieving the document status
You can get the document status by the Editor Application API.