Developers

Here we will explain how to use the new API of Clk.im . There were some changes to the API in order facilitate requests from developers.

Registering for an API Key

As before, an API key is required for requests to be processed by the system. Once a user registers, an API key is automatically generated for this user. The API key must attached to request via the api parameter (see full example below).

Sending a request for shortening a URL

To send a request, the user must use the following format where the variables api and url are required. In the example below, the URL of the demo is used but you should use your own domain name. To request a custom alias, simply add &custom= at the end.

GET https://api.clkim.com/?key=YOUR_API_KEY&url=LONG_URL_HERE

If you want to use a branded domain

GET https://api.clkim.com/?key=YOUR_API_KEY&url=LONG_URL&domain=BRANDED_DOMAIN

Server response

As before, the response will encoded in JSON format (default). This is done to facilitate cross-language usage. The first element of the response will always tell if an error has occurred (error: 1) or not (error: 0). The second element will change with respect to the first element. If there is an error, the second element will be named “msg”. which contains the source of error, otherwise it will be named “short” which contains the short URL. (See below for an example)

Follow us

About Us

Clkim was built to enable non-technical users to shorten, share and monetize their content in an elegant & highly effective way.
Our technology was hand crafted by industry experts, fine tuned by our community and tailored to your needs.