OpenAPI调试台
收藏我的收藏
收藏调试台简介
为帮助开发者快速学习抖音开放平台提供的服务端OpenAPI，特提供「OpenAPI调试台」。开发者可以在调试台内验证接口真实的调用逻辑和响应参数，提升OpenAPI的学习和调试效率。支持的调试功能包括：
- 1.调试台内支持自动获取授权凭证，输入API的入参以验证接口调用结果，同时可查看接口响应结果的具体表现
- 2.调试台支持“沙盒模式”，可以在与线上生产环境相隔离的测试环境中进行调试，不影响线上业务
- 3.对于需要多个OpenAPI按照先后顺序串行调用的场景，调试台支持“链式调用”，开发者可以将多个API加入到调试链中串行执行
使用路径
- 1.开发者可以在OpenAPI对应的接口文档右上角，点击按钮“在线调试”进入调试台
- 2.如需使用“链式调用”等更多模块，可点击按钮“调试其他API”
操作指引
抖音开放平台的OpenAPI调试台有两种场景：
- •在文档站通过抽屉方式打开
- •独立的页面，在抽屉页面中点击
调试其他API或直接打开链接
点击顶部栏的dropdown组件中可以选择OpenAPI的类型，当前支持调试小程序、移动/网站应用、生活服务商家应用、小游戏和服务商平台类型的OpenAPI。
使用 OpenAPI 调试台的步骤如下：
- 1.选择 API 接口：在 OpenAPI 调试台页面或文档站上，选择需要调试的 API 接口。
- 2.输入参数：在 API 接口的页面上，输入需要调试的参数。
- 3.发送请求：点击“发起调试”按钮，向 API 接口发送请求。
- 4.查看结果：在 OpenAPI 调试台的页面上，查看请求的结果，包括响应状态码、响应时间、响应数据等等。
通过使用 OpenAPI 调试台，开发人员可以快速了解 API 的功能和参数，并验证 API 接口的正确性。同时，OpenAPI 调试台也可以帮助开发人员快速调试 API 接口，提高开发效率。
功能介绍
选择应用 & 获取授权凭证
需要开发者先登录开发者账号。
- •页面左侧菜单栏
上下文变量 / 应用信息一栏可选择开发者账号下有权限的应用。
- •当选择某个应用后，开发者可点击查看按钮获取非用户授权凭证（client_token）和用户授权凭证（access_token）
- •对于非用户授权凭证（client_token），若存在未过期token，则直接获取线上未过期token。
- •对于用户授权凭证（access_token），需要开发者手动输入secret，并选择需要调试的scope能力，最后通过抖音App扫码获取。当完成整个流程的操作后，左侧会展示
access_token和扫码用户的open_id。
创建变量
OpenAPI调试台支调试时使用变量。变量类型有应用变量和自定义变量。
应用变量
应用变量有AppId/ClientId，client_token，access_token和open_id。当开发者未在
上下文变量 -> 应用信息选择应用时，则不会显示应用变量。
当选择某个应用后，并且点击查看授权凭证按钮后，则会显示应用变量。
自定义变量
自定义变量支持创建固定值参数和提取API的变量。
- •固定值参数支持一下类型
- ◦Number
- ◦String
- ◦Boolean
- •提取API参数
- ◦API的请求参数
- ◦API的响应参数
下面将重点介绍提取API参数。
- 1.当变量来源选择
提取参数时，需要选择来自接口，来自接口的选择项是tab中打开的API。
- 2.选择接口后，需要选择变量的提取位置：请求参数和响应参数。这个决定变量依赖的是API的请求参数还是响应参数。
- 3.提取表达式根据下拉框选择参数，也可手动输入JSON Path类型的字符串进行自定义。
变量使用方法
当创建好变量后，直接拖拽到目标区域或者在请求参数输入框中输入
{{变量名}}格式的字符串，再点击发起调试按钮后，调试台会自动将变量替换为真实值并发起请求。
API 链式调用
链式调用支持将多个API加入到调试链中串行执行。建议搭配自定义变量使用，将上个API请求返回的参数当做下个API请求的入参。同时，OpenAPI调试台支持将链式调用调试保存至云端，下一次调试直接在左侧tab栏选择相应的链式调用保存记录继续调试。
下面的视频将以获取非用户授权凭证并以返回的client_token获取小程序二维码为例，以此展示链式调用的使用方法。
链式调用同时还支持保存，关闭调试台页面后可加载上一次保存的调试记录。
