Chakloon Platform
Для разработчиков: как получить ключ API Chakloon, какие API и бесплатные квоты доступны и как добавить на свой сайт вход через Chakloon.
Что это
Chakloon Platform на platform.chakloon.com — кабинет для разработчиков. Один ключ API вида ck_live_… работает для всех API Chakloon. Запросы идут на api.chakloon.com. Документация каждого метода есть в кабинете на platform.chakloon.com/docs.
Как получить ключ API
- Откройте platform.chakloon.com и войдите через Chakloon Passport.
- Создайте ключ. Скопируйте его сразу: его показывают только один раз.
- Отправляйте ключ с каждым запросом в заголовке Authorization: Bearer ck_live_….
Храните ключи на своём сервере. Никогда не вставляйте ключ в веб-страницу или мобильное приложение, откуда его может прочитать кто угодно. Если ключ мог попасть в чужие руки, отзовите его в кабинете и создайте новый.
API и бесплатные квоты
| API | Что даёт | Бесплатная квота |
|---|---|---|
| Погода | погода сейчас, почасовой и ежедневный прогноз, предупреждения и астрономия для точки или места | 1 000 запросов в день |
| Поиск | результаты из веба и новостей из индекса Chakloon Net на 28 языках | 2 000 запросов в месяц |
| Подсказки | подсказки запроса во время ввода | 20 000 запросов в месяц |
| Вход через Chakloon | вход на ваш сайт через Chakloon Passport, OpenID Connect | бесплатно |
Когда бесплатная квота исчерпана, API до следующего периода отвечает HTTP 402 с кодом quota_exceeded. Каждый ответ содержит заголовки, которые показывают вашу квоту и остаток. Есть также ограничение числа запросов в минуту; когда оно достигнуто, API отвечает HTTP 429 и сообщает, когда повторить.
Платное использование сверх бесплатных квот и пополнение баланса картой ещё не включены. Если вам уже сейчас нужно больше, чем даёт бесплатная квота, напишите на support@chakloon.com и опишите свой проект.
Данные погоды в каждом ответе сопровождаются указанием источников, и его нужно показывать.
Вход через Chakloon
Дайте людям входить на ваш сайт или в приложение через Chakloon Passport, бесплатно.
- В кабинете создайте приложение.
- Укажите адреса, на которые пользователи возвращаются после входа, по одному в строке. Используйте полные адреса https://; для разработки разрешён http://localhost.
- Скопируйте идентификатор клиента и секрет клиента. Секрет показывают только один раз.
- Подключите сайт с помощью любой библиотеки OpenID Connect. Адрес конфигурации указан в документации.
После входа вы получаете постоянный идентификатор пользователя, ник Chakloon, имя, адрес почты и признак, подтверждён ли он. За данные своих пользователей, полученные таким образом, отвечаете вы.
Правила и куда писать
Условия использования, правила допустимого использования и обработки данных изложены в документе Условия API, вместе с общими Условиями использования и Политикой конфиденциальности. О изменениях, которые ломают существующие интеграции, и о прекращении версии API мы сообщаем заранее, как описано в Условиях API.
- Помощь с ключами, квотами и подключением: support@chakloon.com.
- Злоупотребление API через чужой ключ: abuse@chakloon.com.