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
HCL 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 HCL Docs.
Opening a document in third-party integrations
In third-party integrations, you can open a document in HCL Docs by the editor application API.

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.
- HCL Docs JavaScript API
  In order to integrate HCL Docs with third-party systems, a solution has been implemented to enable browser-side integration by releasing one HCL Docs JavaScript SDK and making some public JavaScript APIs available.
- REST APIs
  HCL 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 HCL Docs.
    - Retrieving document information
      You can retrieve document information such as document type and size supported by HCL 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 HCL 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 HCL Docs.
- Developing with third-party integration APIs
  Learn how to develop with third-party integration APIs in HCL Docs. For more information about required APIs with third-party integration, go to APIs for integrating with other repositories.

Opening a document in third-party integrations

In third-party integrations, you can open a document in HCL Docs by the editor application API.

Table 1. Editor Application API
This table provides reference information for the Editor Application API to open a document
Method	URI	Description	Parameters or variables
GET	/docs/driverscallback	This URI should be called by window.open to open the document in HCL Docs.	repository: Values are cmis and rest file_id: The value is a document ID oauth_code (optional): The value is OAuth2 code obtained from the OAuth2 server
GET	/docs/app/doc/external.rest/${file_id}/edit/content	This URI should be called by window.open to open the document in HCL Docs and the URI can be used as the value of HTML iframe src attribute to render the document in HTML iframe.	repository: Value is rest file_id: The value is a document ID

Example

GET /docs/driverscallback?repository=cmis&file_id=a_file_id&code=oauth_code  
GET /docs/driverscallback?repository=rest&file_id=a_file_id&code=oauth_code

Output: The file with file_id will be opened in HCL Docs.

GET /docs/app/doc/external.rest/a_file_id/edit/content

Output: The file with file_id will be opened in HCL Docs.

When the URI is used in HTML iframe, example is:

< iframe src="https://docs.com/app/doc/external.rest/a_file_id/edit/content" 
width="600" height="400" scrolling="yes" frameborder="0">
</iframe >

Rate this topic

5 stars 4 stars 3 stars 2 stars 1 star

Comment on this topic.

By clicking this box, you acknowledge that you are NOT a U.S. Federal Government employee or agency, nor are you submitting information with respect to or on behalf of one. HCL provides software and services to U.S. Federal Government customers through its partners immixGroup, Inc. Contact this team at https://hcltechsw.com/resources/us-government-contact. Do not include any personal data in this Comment box. Note: To report a problem or question about the product software, do not use this form. Instead, go to the HCL Software Support site.