API调试台

1. 简介

1.1 功能简介

API 调试台是指，开发者在调试台中选择需要调试的接口，并输入相应的 API 密钥及请求参数即可进行调试。能够降低开发者的开发成本，让开发者可以快速上手、完成开发。

1.2 使用场景

适用于开发人员在开发过程中，根据接口信息发送请求、查看响应和调整参数。如：

1.3 预期效果

以「获取成员信息」接口调试为例，效果如下所示：

2. 操作步骤

2.1 操作入口

1）参数说明处入口

通过「参数说明 >> API 调试台」处，可以进入 API 调试平台直接进行接口调试：

2）接口文档内入口

除了参数说明文档中可以进入到 API 调试平台，帮助文档对应的接口文档也可以直接进入到 API 调试平台，如下图所示：

2.2 选择接口

在左侧「API 列表」中，选择需要进行调试的接口。如选择「获取成员信息」接口，如下所示：

2.3 设置请求头

选择接口后，设置如下所示内容：

2.4 设置请求体

在请求体中修改必填参数，以便对接口进行调试。如在「获取成员信息」接口当中，需将参数 username 替换为简道云企业内要查询的成员编号，如下所示：

2.5 查看调试结果

1）请求头和请求体都设置完成后，点击「开始调试」，即可查看调试结果。如下所示：

2）API 调试台还会根据开发者输入的请求参数实时生成多语言调用示例，开发者可以一键拷贝示例代码，复用到自己的业务代码中，从而提高开发效率。

3）若调用失败，可以直接查看帮助文档和错误码等信息来快速定位和分析问题，从而降低开发成本。以查看错误码为例，效果如下所示：

2.6 效果演示

效果参见本文【1.3 预期效果】。