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.
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.

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.
- 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.
  - Using comments API for third-party integration
    If you have already applied HCL Docs 2.0 CR2 or later versions, in third-party integrations, you can implement two RESTful APIs to enable the HCL Docs comments service. The REST endpoint is able to be configured in the Docs configuration file concord-config.json.
  - Enabling document status notification API
    Through this REST API, a notification about whether the document is being edited or closed will be posted to the 3rd party repository. It is only available in HCL Docs 2.0.1 and later fixes.

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.

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.