Як почати користуватися SDK Requiply

@requiply/api-sdk є офіційним TypeScript-клієнтом для публічного API Requiply. Він працює в Node.js, serverless-функціях, Next.js, Nuxt і браузерах, а вхідні дані й відповіді в ньому типізовані. Ця сторінка приблизно за десять хвилин проведе вас від нуля до запиту на бронювання у вашому акаунті Requiply.

1. Створіть API ключ

Виконайте кроки зі сторінки Як згенерувати API-токен і оберіть Секретний. Збережіть ключ у змінній середовища:

REQUIPLY_SECRET_KEY=rq_sk_live_...

Створюєте вітрину, що працює в браузері? Тоді створіть Публічний ключ. Він уміє все, що описано на цій сторінці, але бронювання потрібно надсилати як запити (asRequest: true).

2. Встановіть пакет

npm install @requiply/api-sdk

Пакет підтримує лише ESM. Вимоги до середовища описано на сторінці Встановлення.

3. Створіть клієнт і зробіть перший виклик

import { RequiplyClient } from '@requiply/api-sdk';

const requiply = new RequiplyClient({
  apiKey: process.env.REQUIPLY_SECRET_KEY!,
});

const org = await requiply.org.info();
console.log(org.name);

Якщо код виводить назву вашої організації, ключ працює. Неправильний або відкликаний ключ викидає RequiplyError зі status 401.

4. Знайдіть товар і розрахуйте ціну

const startDate = '2026-11-10T10:00:00';
const endDate = '2026-11-12T18:00:00';

const inventory = await requiply.inventory.list({ startDate, endDate });
const item = inventory.items[0];

const quote = await requiply.pricing.quote({
  startDate,
  endDate,
  items: [{ groupId: item.id, quantity: 1 }],
});

console.log(item.name, item.availableQuantity, quote.total, quote.currency);

Дати без зсуву читаються в часовому поясі вашої організації. Завжди вказуйте час: дата без часу означає північ, а це зазвичай поза робочими годинами. Розрахунок застосовує ті самі правила, що й застосунок: кількісне ціноутворення, знижку клієнта й послуги.

5. Надішліть запит на бронювання

const request = await requiply.bookings.create({
  startDate,
  endDate,
  items: [{ groupId: item.id, quantity: 1 }],
  deliveryType: 'pickup',
  asRequest: true,
  client: { name: 'Sophie', lastName: 'Marlow', email: 'sophie.marlow@example.com' },
});

if (request.success) {
  console.log('Booking request', request.reservationOrgId);
} else {
  console.log('Not accepted:', request.message);
}

Клієнта шукають за електронною поштою, потім за телефоном, а якщо не знаходять, створюють нового. Бронювання, яке Requiply не може прийняти, наприклад на неробочий день чи без вільних одиниць, повертає success: false і message замість винятку.

6. Перевірте в Requiply

1. Запит: статус запиту на бронювання. Персонал переводить його далі стрілкою поруч із тегом.
2. Клієнт: клієнт, якого SDK знайшов або створив.
3. Період оренди: дати, які ви надіслали, у часовому поясі вашої організації.

Запит також зʼявляється в мобільному застосунку в розділі Бронювання.

Поширені запитання

Що використовувати: SDK чи REST API?

Використовуйте SDK у JavaScript і TypeScript. В інших мовах викликайте REST API з тим самим ключем: SDK є тонким типізованим шаром над ним.

Як створити підтверджене бронювання замість запиту?

Використайте секретний ключ, не передавайте asRequest і вкажіть paymentType. Див. Бронювання.

Як обробляти помилки?

Перехоплюйте RequiplyError і читайте status та reason. Помилка 429 містить retryAfter у секундах. Див. Обробка помилок.

Чи є пісочниця?

Ні. Кожен ключ працює з реальними даними, тому тестуйте на демо-організації. Див. Тестового режиму немає.

Наступні кроки

• Швидкий старт: приклади для сервера й для вітрини поруч.
• Ресурси SDK: усі методи за ресурсами.
• Приклади: підходи для вітрин та інтеграцій.