Документація для розробників
Публічний API Requiply дає змогу вашому сайту, застосунку чи внутрішньому інструменту читати каталог, перевіряти доступність, розраховувати ціну, приймати запити на бронювання, а також працювати з бронюваннями, клієнтами, продажами та звітами.
Способи інтеграції
| Варіант | Найкраще підходить для |
|---|---|
TypeScript SDK (@requiply/api-sdk) | Застосунків на JavaScript і TypeScript: Next.js, Nuxt, Node.js, serverless-функцій і браузерів. Типізовані вхідні дані та відповіді, серіалізація запитів і RequiplyError. |
| REST API | Будь-якої іншої мови чи середовища виконання. JSON через HTTPS за адресою https://api.requiply.com/api/public/v1. |
| MCP-сервер | AI-агентів, які мають працювати з даними організації через інструменти, а не через HTTP-запити. |
Для JavaScript рекомендовано SDK. Ці посібники описують SDK версії 0.2.0, яка підтримує Node.js 18 або новіший і сучасні браузери з fetch. Окремі пакети @requiply/next і @requiply/nuxt заплановано, але поки вони недоступні.
З чого почати
- Створіть API ключ і виберіть публічний чи секретний.
- Встановіть SDK.
- Пройдіть Швидкий старт, щоб зробити перший серверний виклик і запит на бронювання з вітрини.
- Шукайте кожен метод у посібниках із ресурсів SDK, а кожен ендпоінт у довіднику REST API.
- Скопіюйте готовий підхід із Прикладів.
Що може вітрина з публічним ключем
- Показувати назву, логотип, робочі години, варіанти доставки та способи оплати організації.
- Показувати категорії, товари й послуги з доступністю на вибрані дати.
- Точно розраховувати ціну із застосованими кількісним ціноутворенням і послугами.
- Надсилати запит на бронювання, який співробітники підтверджують у застосунку.
- Пропонувати товари на продаж разом із бронюванням, коли організація продає клієнтам.
Для всього іншого, зокрема клієнтів, бронювань, продажів і звітів, потрібен секретний ключ на сервері.
Посилання на пакет
Використання AI
Відстежуйте, скільки AI-кредитів включає ваш тариф і скільки вже використано, та купуйте додаткові кредити для асистента, створення шаблонів, фото комплектів, вебвіджета і чату на порталі.
Автентифікація та API ключі
Створюйте, називайте й відкликайте API ключі Requiply, обирайте між публічним ключем для браузерних вітрин і секретним ключем для серверів і дізнайтеся про обмеження частоти запитів.