API Playground

API Playground 提供了一个简化的测试环境，使您可以测试多个 API 接口并验证有效负载。此互动工具可帮助开发者实时验证 API 行为，实现流畅的集成体验。

注意
API Playground 目前仅支持部分 Marketing API 接口。若想查看支持的接口，可参阅 API Playground 中支持的接口列表。

使用 API Playground

前提条件

• 已创建 TikTok For Business 账号。欲了解更多详情，请查看创建 TikTok For Business 账号。
• 已注册成为开发者。欲了解更多详情，请查看注册成为开发者。
• 已创建开发者应用。欲了解更多详情，请查看创建开发者应用。
• 已完成 Marketing API 授权。欲了解更多详情，请查看 OAuth 授权。
• 若要测试不同接口的有效负载，您需要获取相关的权限。参阅 API 参考了解使用相关接口所需的权限；参阅更新应用权限范围了解如何设置权限。

步骤

1. 访问 API Playground

直接导航至 API Playground。请注意，需要登录才能使用此工具。

2. 生成 Marketing API 访问令牌

默认显示/oauth2/access_token/的测试页面。

i. 在 Request payload（请求有效负载） 选项卡下，输入从 OAuth 授权步骤中获得的 app_id、auth_code 和 secret。

ii. 单击 Submit（提交）。Response body （返回 body）选项卡将显示调用 Marketing API 接口所需的 access_token（访问令牌）。

3. 测试其他 Marketing API 接口

i. 使用搜索栏按 API 名称或路径查找某一接口，例如 /v1.3/bc/get/。

ii. 单击 API Doc （API 文档）查看所选接口的完整参数表。

iii. 若接口需要访问令牌，需在 Request Header （请求 Header）选项卡下输入从步骤 2 获得的访问令牌。

注意
您在某个接口的测试页面上输入访问令牌后，所有其他接口页面上的 Access Token （访问令牌）字段将自动填充相同的令牌，直到您刷新了页面。此功能可帮助您高效地测试多个接口。

iv. 在 Request payload（请求有效负载） 选项卡下，根据需要自定义有效负载。例如，如果您想要检索您可以访问的所有商务中心，需从有效负载中删除 bc_id。

v. 点击 Submit（提交）。随后可在 Request body （请求 body）选项卡下查看返回结果。

4. 复制代码示例

i. 在 Code example （代码示例）选项卡的右上角，点击复制按钮，获取 curl 格式的代码示例。

ii. 将代码示例导入您的集成工具中进行进一步测试。