Help

Chakloon Platform

For developers: how to get a Chakloon API key, which APIs and free quotas are available, and how to add Sign in with Chakloon to your site.

What it is

Chakloon Platform at platform.chakloon.com is the cabinet for developers. One API key, of the form ck_live_…, works for all Chakloon APIs. Requests go to api.chakloon.com. The documentation of every method is in the cabinet at platform.chakloon.com/docs.

Get an API key

  1. Open platform.chakloon.com and sign in with your Chakloon Passport.
  2. Create a key. Copy it at once: it is shown only once.
  3. Send the key with every request in the header Authorization: Bearer ck_live_….

Keep keys on your server. Never put a key into a web page or a mobile app, where anyone can read it. If a key may have leaked, revoke it in the cabinet and create a new one.

APIs and free quotas

API What it gives Free quota
Weather current weather, hourly and daily forecast, warnings and astronomy for a point or a place 1 000 requests a day
Search web and news results from the Chakloon Net index in 28 languages 2 000 requests a month
Suggest query suggestions while the user types 20 000 requests a month
Sign in with Chakloon sign-in for your site with Chakloon Passport, OpenID Connect free

When a free quota is used up, the API answers with HTTP 402 and the code quota_exceeded until the next period. Each response carries headers that show your quota and how much of it is left. There is also a limit on requests per minute; when you reach it, the API answers with HTTP 429 and tells you when to retry.

Paid usage above the free quotas and card top-ups of the balance are not switched on yet. If you need more than the free quota now, write to support@chakloon.com and describe your project.

Weather data comes with an attribution of its sources in every response, and you must show it.

Sign in with Chakloon

Let people sign in to your site or app with their Chakloon Passport, free of charge.

  1. In the cabinet, create an app.
  2. Enter the addresses your users return to after sign-in, one per line. Use full https:// addresses; http://localhost is allowed for development.
  3. Copy the client ID and the client secret. The secret is shown only once.
  4. Connect your site with any OpenID Connect library. The address of the configuration is in the documentation.

After sign-in you receive a stable user ID, the Chakloon handle, the name, the e-mail address and whether it is verified. You are responsible for the data of your users that you receive this way.

Rules and where to write

The conditions of use, acceptable use and data processing are in the API Terms, together with the general Terms of Service and Privacy Policy. We announce changes that break existing integrations, and the end of an API version, in advance, as described in the API Terms.