Автентифікація та API ключі
Кожен запит до публічного API, із SDK чи через REST, передає API ключ як bearer-токен:
Authorization: Bearer <api-key>
Створення ключа
API ключами керують у Налаштування → Організація → API ключі (app.requiply.com/settings/org/api-keys). Цю сторінку бачать лише учасники з роллю Адмін.
- Натисніть Створити ключ.
- Введіть Назва, яка показує, де використовується ключ, наприклад Сайт на Lovable чи Синхронізація з бухгалтерією.
- Виберіть Тип: Публічний або Секретний.
- Натисніть Створити ключ, потім скопіюйте ключ у діалозі Збережіть цей ключ зараз.
Таблиця показує кожен ключ із назвою, типом, замаскованим Ключ (префікс і останні чотири символи, яких досить, щоб розрізнити ключі), датою створення та Останнє використання. Олівець перейменовує ключ. Іконка заборони відкликає його: відкликаний ключ одразу перестає працювати без можливості відновлення. Увімкніть Показати відкликані, щоб бачити відкликані ключі.
Вибір типу ключа
Публічний ключ (rq_pk_…) | Секретний ключ (rq_sk_…) | |
|---|---|---|
| Де використовується | Код у браузері, сайт, мобільний застосунок | Лише серверний код і змінні середовища |
| Інформація про організацію, каталог, послуги | Так | Так |
| Доступність і розрахунок ціни | Так | Так |
| Бронювання | Лише запити на бронювання (asRequest: true) | Створення, список, читання, додавання нотаток |
| Товари на продаж | Перегляд і додавання до запиту на бронювання, поки організація продає клієнтам | Усе в Продажі |
| Клієнти, звіти, стан інвентарю, зведення організації | Ні | Так |
| Товари суборенди від постачальників | Ніколи | Коли ввімкнено суборенду |
| Коригування вартості бронювання, бронювання поза робочим часом | Ні | Так |
Повний перелік за ендпоінтами наведено в довіднику REST API.
Публічні ключі
Публічний ключ бачить кожен, хто відкриє вихідний код вашої сторінки, а API приймає його з будь-якого джерела. Безпеку забезпечує його обсяг доступу: він читає каталог, розраховує ціну та надсилає запити на бронювання, які співробітники підтверджують у застосунку. Він ніколи не бачить записів клієнтів чи звітів, ніколи самостійно не утримує інвентар і не може купити товарів більше, ніж є в наявності. Якщо ключ використовують зловмисно, відкличте його і створіть новий.
const requiply = new RequiplyClient({ apiKey: 'rq_pk_live_...' });
Секретні ключі
Секретний ключ діє від імені всієї організації, а не окремого члена команди. Зберігайте його в серверному коді та змінних середовища:
REQUIPLY_SECRET_KEY=rq_sk_live_...
const requiply = new RequiplyClient({
apiKey: process.env.REQUIPLY_SECRET_KEY!,
});
NEXT_PUBLIC_… чи NUXT_PUBLIC_….SDK відмовляється працювати з ключем rq_sk_ у браузері. Для локальних інструментів є перевизначення dangerouslyAllowSecretKeyInBrowser, яке робочі інтеграції ніколи не мають вмикати.
Обмеження частоти запитів
Кожен ключ може робити 100 запитів на хвилину. Наступні запити отримують 429 із заголовком Retry-After у секундах, який SDK надає як RequiplyError.retryAfter. Браузери не можуть прочитати цей заголовок у міждоменних запитах, тож вітрині варто зачекати кілька секунд перед повторною спробою. Див. Обробка помилок.
Міждоменні запити
Публічний API відповідає на запити з будь-якого джерела, тож домен реєструвати не потрібно. Браузери можуть надсилати такі заголовки: Authorization, Accept, Content-Type. Міждоменний запит з іншим власним заголовком блокується ще до того, як дійде до Requiply.
Тестового режиму немає
Кожен ключ працює зі справжніми даними. Для інтерактивної документації та демонстрацій використовуйте публічний ключ демо-організації. Усе, що створює бронювання чи продажі, спрямовуйте на організацію, записи якої можна видалити.
AI-агенти та MCP
Той самий секретний ключ також відкриває MCP-сервер Requiply для агента, якого ви створюєте самі. Надсилайте його як bearer-токен на https://api.requiply.com/api/mcp. Агент отримує інструменти рівня організації, які дозволяє секретний ключ. Записи все одно проходять крок попереднього перегляду й підтвердження, описаний на тій сторінці. Асистенти на кшталт Claude і ChatGPT натомість підключаються через OAuth і ключа не потребують. Публічні ключі не можуть відкрити MCP-сервер.