> For the complete documentation index, see [llms.txt](https://www.boxhero.io/docs/llms.txt). Every page is available as Markdown by appending `.md` to its URL; this page is [Markdown](https://www.boxhero.io/docs/zh-cn/developers/api/quickstart.md).

# 快速入门

> 签发 API 令牌，并向 BoxHero API 发送第一个请求。

本指南将带您从零开始，完成第一次成功的 API 调用。

## 1. 签发 API 令牌

在桌面版网页应用中，打开要连接的团队，进入 `设置` > `集成和 API`。生成新的 API 令牌并复制。

![](https://assets.boxhero.io/docs/images/e6bbc8fa4eab21ec0f9ebe74893cd3a6e0c6a5d4d178ae02478ef99adbe4c4cd-2214x1431.jpg)

> **Caution**
>
> **注意**：令牌与签发它的团队绑定，可以通过 API 完全访问该团队的数据。请将令牌保存在您的服务器上，切勿放入移动应用、浏览器代码或公开代码库中。

## 2. 发送第一个请求

调用[获取关联团队](https://www.boxhero.io/docs/zh-cn/developers/api/reference/teams/get-linked-team)，确认令牌是否有效。在 `Authorization` 请求头中发送令牌：

```bash
curl https://rest.boxhero-app.com/v1/teams/linked \
  -H "Authorization: Bearer $BOXHERO_API_TOKEN"
```

响应会返回令牌所属团队的信息：

```json
{
  "id": 149058,
  "name": "Acme Retail",
  "mode": 2,
  "currency_symbol": "$",
  "currency_code": "USD",
  "price_decimal_places": 2,
  "memo": null
}
```

如果返回的是 `401`，说明未发送令牌或令牌复制不完整。有关错误格式，请参阅[错误](https://www.boxhero.io/docs/zh-cn/developers/api/errors)。

> **Note**
>
> 大多数端点仅适用于按[位置](https://www.boxhero.io/docs/zh-cn/concepts/locations)管理库存的团队。对于其他团队，这些端点会返回类型为 `/errors/invalid-team-mode` 的错误。位置模式团队在上述响应中的 `mode` 为 `2`。

## 3. 后续步骤

- 使用[获取商品列表](https://www.boxhero.io/docs/zh-cn/developers/api/reference/items/list-items)列出库存，并在[分页](https://www.boxhero.io/docs/zh-cn/developers/api/pagination)中了解如何获取所有页面。
- 使用[创建库存记录](https://www.boxhero.io/docs/zh-cn/developers/api/reference/transactions/create-transaction)记录库存变动，相关规则请参阅[库存记录](https://www.boxhero.io/docs/zh-cn/developers/api/reference/transactions)。
- 使用 [Webhook](https://www.boxhero.io/docs/zh-cn/developers/webhooks/overview) 接收变更通知，无需轮询。
- 在 [API 参考](https://www.boxhero.io/docs/zh-cn/developers/api/reference)中浏览所有端点。