使用准备
从开发团队获取要调用的 API 信息，如果 API 需要认证，则登记认证信息。
第 1 步：准备要调用的 API
Section titled “第 1 步：准备要调用的 API”请向开发团队索取以下四项信息，并把 API 对接指南 页面一并分享给开发团队。
| 需要获取的信息 | 用途 | 示例 |
|---|---|---|
| API 地址 | 原样填入指令中 | https://api.example.com/points |
| 请求方式 | GET 和 POST 的写法不同 | GET |
| 认证方式 | 如果需要认证，在第 2 步中登记 | Basic 或 Token，不需要认证则无需填写 |
| 响应示例（JSON） | 确认哪些字段可以用在消息中 | {"amount": 12000, "expires_at": "2026-09-30"} |
第 2 步：登记认证信息
Section titled “第 2 步：登记认证信息”如果 API 无需认证即可调用，请跳过这一步。
需要认证的 API，不要把 ID 或令牌直接写在消息里，而是先登记，然后在消息中只通过名称调用。
打开认证信息区域
Section titled “打开认证信息区域”在 设置 › 项目 中，每个项目最多可以登记 10 个认证信息。
选择认证方式并填写
Section titled “选择认证方式并填写”根据开发团队提供的认证方式，选择 Basic 或 Token。
| 认证方式 | 适用情况 | 填写项 |
|---|---|---|
| Basic | 使用 ID 和密码认证的 API | 认证名称、ID、PW、允许的域名 |
| Token | 像 Authorization: Bearer ... 这样通过请求头认证的 API | 认证名称、请求头名称、请求头值、允许的域名 |
- 认证名称请起一个能看出是哪个 API 的名字，例如
stock_api。 - 允许的域名只有与调用地址的域名完全一致时才会生效，子域名也不算在内。
| 登记的域名 | 调用地址 | 是否生效 |
|---|---|---|
api.example.com | https://api.example.com/stock | 生效 |
api.example.com | https://other.example.com/stock | 不生效 |
api.example.com | https://shop.api.example.com/stock | 不生效 |
在列表中点击认证名称左侧的复制按钮，即可复制为可以直接粘贴到消息中的格式。
