身份验证
使用 Bearer 令牌对 BoxHero API 请求进行身份验证,并将请求发送到带版本号的基础 URL。
API 令牌
Section titled “API 令牌”每个请求都必须在 Authorization 请求头中以 Bearer 令牌的形式携带 API 令牌:
Authorization: Bearer <api-token>请在 BoxHero 应用的 设置 > 集成和 API 中签发令牌。每个令牌只绑定一个团队:所有请求都只读写该团队的数据。如需操作多个团队,请在每个团队中分别签发令牌。
不支持匿名访问。令牌缺失或无效时,所有端点都会返回 401 和错误信封。
基础 URL 和版本
Section titled “基础 URL 和版本”所有请求都发送到:
https://rest.boxhero-app.com所有端点都位于 /v1 前缀下,例如 GET /v1/items。
大多数端点仅适用于按位置管理库存的团队。对于其他团队,这些端点会返回 400 和错误类型 /errors/invalid-team-mode。团队、成员、合作伙伴和属性端点适用于所有团队。调用获取关联团队即可查看您的团队使用的模式。