⌘K
クイックスタート
Bookmiを使い始めるための基本的なステップをご紹介します。
インストール
npmまたはyarnを使用して、Bookmi SDKをインストールします。
bash
# npm
npm install @bookmi/sdk
# yarn
yarn add @bookmi/sdk
# pnpm
pnpm add @bookmi/sdk注意
Node.js 18.0以上が必要です。
クイックサンプル
以下は、Bookmi APIを使用して予約を作成する基本的な例です。
example.ts
import { Bookmi } from '@bookmi/sdk';
// クライアントの初期化
const bookmi = new Bookmi({
apiKey: process.env.BOOKMI_API_KEY,
});
// 予約の作成
const reservation = await bookmi.reservations.create({
date: '2024-03-15',
time: '19:00',
partySize: 4,
customer: {
name: '山田太郎',
phone: '090-1234-5678',
email: '[email protected]',
},
});
console.log('予約ID:', reservation.id);主要なエンドポイント
| メソッド | エンドポイント | 説明 |
|---|---|---|
GET | /api/v1/reservations | 予約一覧を取得 |
POST | /api/v1/reservations | 新規予約を作成 |
GET | /api/v1/customers | 顧客一覧を取得 |
PUT | /api/v1/reservations/:id | 予約を更新 |
認証が必要
すべてのAPIリクエストには、有効なAPIキーが必要です。詳しくは認証ガイドをご覧ください。