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.