# @boulevard/blvd-book-sdk 中文文档

规范地址：https://npmcn.com/package/%40boulevard/blvd-book-sdk/

版本：2\.0\.10
npm 元数据更新时间：2025-09-23T17:32:42.634Z
中文译文更新时间：2026-11-08T12:37:27.054Z
软件包许可：UNLICENSED

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40boulevard/blvd-book-sdk
原文对照：https://npmcn.com/package/%40boulevard/blvd-book-sdk/?lang=original
项目主页：https://github.com/Boulevard/book-sdk#readme
源码仓库：https://github.com/Boulevard/book-sdk

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：992 kB，13 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：4 个
- 首次发布：2021-06-21T15:53:21.879Z
- 最新版本发布：2025-09-23T17:32:42.374Z
- 近 30 天下载量：2595（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：62（近 12 个月 0 个）

## 中文简介

API大道的JS客户端

## 安装

```sh
npm install @boulevard/blvd-book-sdk
```

也可以使用：`pnpm add @boulevard/blvd-book-sdk`、`yarn add @boulevard/blvd-book-sdk`、`bun add @boulevard/blvd-book-sdk`

## README

[![TypeScript](https://badgen.net/badge/icon/typescript?icon=typescript&label)](https://typescriptlang.org/) [![GitHub license](https://img.shields.io/github/license/Boulevard/book-sdk)](https://github.com/Boulevard/book-sdk/blob/master/LICENSE.md) [![GitHub release](https://img.shields.io/github/release/Boulevard/book-sdk)](https://github.com/Boulevard/book-sdk/releases/) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/Boulevard/book-sdk/compare)

## 大道图书软件开发套件

[报告错误](https://github.com/Boulevard/book-sdk/issues) • 妇女 [请求特性](https://github.com/Boulevard/book-sdk/issues)

目录

1.  [开始](https://npmcn.com/package/%40boulevard/blvd-book-sdk/#readme-getting-started)
2.  [文档](https://npmcn.com/package/%40boulevard/blvd-book-sdk/#readme-documentation)
3.  [发展](https://npmcn.com/package/%40boulevard/blvd-book-sdk/#readme-development)
4.  [捐款](https://npmcn.com/package/%40boulevard/blvd-book-sdk/#readme-contributing)
5.  [问题](https://npmcn.com/package/%40boulevard/blvd-book-sdk/#readme-issues)

* * *

## 关于项目

[大道](https://joinblvd.com/) 是一个智能的日程安排解决方案和综合销售点系统,它增加了沙龙、疗养院和其他预约企业的收入并降低了成本.

通过这个软件开发工具包(SDK),您可以使用大道为自己的业务创建自定义的预订体验.

## 开始

### 设置

去那边 [大道开发者门户](https://developers.joinblvd.com/getting-started/introduction) 要设置一个沙盒账户和 API 应用程序。 你需要你的商业身份和API密钥来使用这个包.

```js
const businessId = "312bf55a-b6c5-48f2-ab40-eef5d78277ac";
const apiKey = "00000000-0000-0000-0000-000000000000";
```

安装 SDK

```sh
npm --save install @boulevard/blvd-book-sdk
```

```sh
yarn add @boulevard/blvd-book-sdk
```

### 客户端

最简单的流程是未经认证的客户端 API,您可以利用它为新客户端创建预约:

```js
import { Blvd } from "@boulevard/blvd-book-sdk";

// Step 1: Create a `business` object to interact with the API.
const client = new Blvd(apiKey, businessId);

// Step 2: Choose a location and start by creating a cart
const business = await client.businesses.get();
const locations = await business.getLocations();

let cart = await client.carts.create(locations[0]);

// Step 3: Select and add items to the card
const item = cart.availableCategories[0].availableItems[0];
cart = await cart.addBookableItem(item);

// Step 4: Find available timeslots
const dates = await cart.getBookableDates();
const times = await cart.getBookableTimes(dates[0]);

// Step 5: Reserve a timeslot, add details, and book!
await cart.reserve(times[0]);

await cart.update({
  email: "john.doe@gmail.com",
  firstName: "John",
  lastName: "Doe",
  phoneNumber: "+13105555555"
});

await cart.addCardPaymentMethod({
  card: {
    name: "John Doe",
    number: "4242424242424242",
    cvv: "111",
    exp_month: 1,
    exp_year: 2028,
    address_postal_code: "90210"
  }
});

await cart.checkout();
```

## 文档

软件包文档可用 [这里](https://boulevard.github.io/book-sdk/index.html)。 。 。 .

要看到可用的 API 操作浏览与类定义挂钩的方法 . [示例 - 墨盒操作](https://boulevard.github.io/book-sdk/classes/carts.cart.html)

## 发展

### 刷新 Sched 绑定

这将从 Sched 中获取图克勒 schema 并生成打字符绑定和模拟 .

```
npm run gen
```

```
yarn run gen
```

### 运行测试

为了能够运行测试,你需要 `ts-node` 已安装全局

```
npm -g install ts-node
```

```
yarn global add ts-node
```

然后你可以进行测试.

```
npm test
```

```
yarn test
```

### 部署

注意,除非你是大道员工... ...你需要打开公关 并寻求批准... ...

首先你需要加入npmjs.com的大道组织 添加后运行以下命令:

```
yarn build && yarn publish
yarn run typedoc
```

然后提交并按 (inc tags) .

## 捐款

欢迎拉动请求。 见 [捐款准则](https://github.com/Boulevard/book-sdk/blob/master/CONTRIBUTING.md) 更多信息.

## 问题

如果您在尝试运行启动套件时遇到任何问题, 请创建一个问题 .

## 常见问题

### @boulevard/blvd-book-sdk 是什么？

API大道的JS客户端

### 如何安装 @boulevard/blvd-book-sdk？

在项目目录运行 npm install @boulevard/blvd-book-sdk，或使用 pnpm add / yarn add / bun add。

### @boulevard/blvd-book-sdk 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @boulevard/blvd-book-sdk 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @boulevard/blvd-book-sdk 可以商用吗？

@boulevard/blvd-book-sdk 使用 UNLICENSED 许可。作者声明为 UNLICENSED，即不授予公开使用许可（与公共领域的 Unlicense 不同）。使用前需获得作者授权。以上为概括，不构成法律意见，请以许可原文为准。

### @boulevard/blvd-book-sdk 的下载量有多少？

根据 npm 官方下载统计，@boulevard/blvd-book-sdk 在 2026/10/09 – 2026/11/07 这 30 天内被下载 2,595 次，日均约 87 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @boulevard/blvd-book-sdk 还在维护吗？

最新版本 2\.0\.10 发布于 2025/09/24（1\.1 年前）；至今共发布 62 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/06/21。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。