Chakloon Platform
Для разработчиков: как получить ключ API Chakloon, какие API, бесплатные квоты и цены действуют, как получать ответы Chacki потоком, как управлять кампаниями Chakloon Ads через API и как добавить на свой сайт вход через Chakloon.
Что это
Chakloon Platform на platform.chakloon.net — кабинет для разработчиков. Один ключ API вида ck_live_… работает для всех API Chakloon. Запросы идут на api.chakloon.com. Документация каждого метода есть в кабинете на platform.chakloon.net/docs.
Как получить ключ API
- Откройте platform.chakloon.net и войдите через Chakloon Passport.
- Создайте ключ. Скопируйте его сразу: его показывают только один раз.
- Отправляйте ключ с каждым запросом в заголовке Authorization: Bearer ck_live_….
Храните ключи на своём сервере. Никогда не вставляйте ключ в веб-страницу или мобильное приложение, откуда его может прочитать кто угодно. Если ключ мог попасть в чужие руки, отзовите его в кабинете и создайте новый.
API и бесплатные квоты
| API | Что даёт | Бесплатная квота |
|---|---|---|
| Погода | погода сейчас, почасовой и ежедневный прогноз, предупреждения и астрономия для точки или места | 1 000 запросов в день |
| Поиск | результаты из веба и новостей из индекса Chakloon Net на 28 языках | 2 000 запросов в месяц |
| Подсказки | подсказки запроса во время ввода | 20 000 запросов в месяц |
| Ответы Chacki | ответ Chacki, который может пользоваться инструментами Chakloon: поиском в вебе, свежими новостями и погодой | нет, платно от 0,03 € за ответ |
| Ссылки | короткие ссылки на chak.uno со статистикой кликов и QR-кодами; каждый адрес проверяется по спискам фишинга и вредоносных программ | 1 000 новых ссылок и 10 000 чтений в месяц |
| Подписи | отправка PDF на подпись в Chakloon Sign: подписанты подписывают по очереди, а вы получаете подписанный PDF со страницей сертификата и публичную страницу проверки | 10 завершённых документов в месяц, далее 0,15 € за документ; отменённые и отклонённые документы бесплатны |
| Papers | публичная запись в Chakloon Papers с квитанцией о том, что файл существовал: вы отправляете только его хеш SHA-256, а файл остаётся у вас | 50 записей в месяц, далее 0,05 € за запись; проверка записи бесплатна |
| Legal | ваши сайты в Chakloon Legal, их журнал согласий, а также политика конфиденциальности, политика cookie, условия использования и импрессум, созданные по вашим ответам, которые вы публикуете в кабинете; сначала один раз откройте legal.chakloon.net, чтобы создать рабочее пространство | чтение бесплатно, 2 € за созданный комплект |
| Реклама | ваши кампании Chakloon Ads, отчёты и баланс | 10 000 запросов в день |
| Вход через Chakloon | вход на ваш сайт через Chakloon Passport, OpenID Connect | бесплатно |
Когда бесплатная квота исчерпана, API до следующего периода отвечает HTTP 402 с кодом quota_exceeded. Каждый ответ содержит заголовки, которые показывают вашу квоту и остаток. Есть также ограничение числа запросов в минуту; когда оно достигнуто, API отвечает HTTP 429 и сообщает, когда повторить.
Платные методы оплачиваются с вашего баланса Chakloon, Kassero, по ценам из документации и Условий API. Цены указаны без НДС; где НДС применяется, его показывают до оплаты. Если баланса не хватает на платный вызов, API отвечает HTTP 402 и вызов не выполняет. Если вам нужно больше, чем даёт бесплатная квота, напишите на support@chakloon.com и опишите свой проект.
Данные погоды в каждом ответе сопровождаются указанием источников, и его нужно показывать.
Ответы Chacki
Метод POST /v1/chacki/answers даёт вашему приложению ответ Chacki. Вы отправляете беседу, до 20 реплик, и Chacki отвечает, где нужно, пользуясь инструментами Chakloon.
- Цена: 0,03 € за ответ до 2 000 токенов вывода и 3 вызовов инструментов; ещё 0,01 € за каждую следующую 1 000 токенов вывода и ещё 0,005 € за каждый следующий вызов инструмента.
- Списание: перед ответом на балансе удерживается сумма, а после него списывается только фактическая цена. Неудавшийся ответ не оплачивается.
- Пометка: ответ создаёт искусственный интеллект. Помечайте это везде, где его показываете. Действуют также Условия использования Chacki.
Ответы потоком
Укажите в запросе stream: true, и ответ будет приходить событиями server-sent events, так что текст можно показывать ещё во время написания:
- start: ответ начался, с его идентификатором;
- tool: Chacki пользуется одним из инструментов;
- delta: следующий кусок текста;
- done: весь ответ с источниками и объёмом использования;
- charge: после done, сумма и валюта, списанные с вашего баланса.
Если что-то пойдёт не так, вместо этого придёт событие error. Вы платите только за написанное: если ваш клиент закроет соединение, ответ остановится, и оплачивается только текст, написанный до этого момента. Если произошла ошибка или поток оборвался до done, ничего не списывается.
API рекламы
API рекламы позволяет рекламодателям Chakloon Ads следить за своими кампаниями и управлять ими из своих систем:
- Кампании: GET /v1/ads/campaigns возвращает список ваших кампаний, GET /v1/ads/campaigns/{id} возвращает одну.
- Пауза и запуск: POST /v1/ads/campaigns/{id}/pause и /resume. Снова запустить можно только кампанию на паузе, которая прошла модерацию.
- Отчёты: GET /v1/ads/reports даёт показы, клики и расходы за период от 1 до 365 дней, по умолчанию 30.
- Баланс: GET /v1/ads/balance показывает ваш рекламный баланс и расходы.
API рекламы работает с тем же ключом, что и другие API, и возвращает только кампании аккаунта, которому принадлежит ключ. Он бесплатный, до 10 000 запросов в день. Создание и редактирование кампаний и пополнение баланса остаются в кабинете на chakloon.net/add, где каждое объявление проходит модерацию до показа. Правила рекламы изложены в документе Правила рекламы и условия для рекламодателей.
Вход через Chakloon
Дайте людям входить на ваш сайт или в приложение через Chakloon Passport, бесплатно.
- В кабинете создайте приложение.
- Укажите адреса, на которые пользователи возвращаются после входа, по одному в строке. Используйте полные адреса https://; для разработки разрешён http://localhost.
- Скопируйте идентификатор клиента и секрет клиента. Секрет показывают только один раз.
- Подключите сайт с помощью любой библиотеки OpenID Connect. Адрес конфигурации указан в документации.
После входа вы получаете постоянный идентификатор пользователя, ник Chakloon, имя, адрес почты и признак, подтверждён ли он. За данные своих пользователей, полученные таким образом, отвечаете вы.
Правила и куда писать
Условия использования, правила допустимого использования и обработки данных изложены в документе Условия API, вместе с общими Условиями использования и Политикой конфиденциальности. Для API рекламы действуют также Правила рекламы и условия для рекламодателей. О изменениях, которые ломают существующие интеграции, и о прекращении версии API мы сообщаем заранее, как описано в Условиях API.
- Помощь с ключами, квотами и подключением: support@chakloon.com.
- Злоупотребление API через чужой ключ: abuse@chakloon.com.