ClickHelp Documentation

ClickHelp API

ClickHelp User Manual/ClickHelp API

Every ClickHelp portal provides a REST API to enable tasks automation and to help you integrate your documentation workflow into the existing business processes. To learn more on this type of APIs, please refer to this Wikipedia article: Representational state transfer

Protocol and Security

REST APIs use the HTTP protocol for communication, which is a text-based protocol. The client side sends API requests in a textual form, and the server response is also represented as text. To make sure this communication is protected, use the HTTPS protocol in all API calls.

When using ClickHelp REST API, make sure you use the HTTPS protocol in all API calls in order to protect the traffic from unauthorized access.
ClickHelp uses the TLS 1.2 cryptographic protocol, so please make sure that your client uses this protocol as well.

If you have configured a custom domain name for your documentation portal, upload your certificate and enable SSL/TLS for your portal before using the API.

cURL Notes

The topics of this section contain API call examples that use the cURL utility, you can find a lot of information about it on the web.

An important thing to note about the examples is that they use the --cacert command line parameter. It specifies the name of the CA Bundle file - a file with the root and intermediate certificates of the certification authority who issued the SSL  certificate of the target endpoint. cURL uses this file to verify the endpoint SSL certificate. This type of file is normally available at the certification authority web site and you can download it.

In ClickHelp, if you are using the default domain name *, you can use this CA Bundle file. If you are using a custom domain name with your own SSL certificate, please request the CA Bundle file from your certification authority.

Continue learning ClickHelp REST API: