使用RESTful API实现自动KPIs数据输入

使用RESTful API实现KPIs自动化数据读写。第三方业务工具自动访问您的数据。

通用信息

• 文档。 用于API调用的文档位于 此处。
• Webhooks. BSC Designer 中的通知功能可以通过 配置 发出网络钩子。
• 限制。. 每个账户下的每位高级用户，每小时限制API调用数量为100 。

入门指南

查看以下指导内容，帮助您尽快入门。

授权令牌

API调用需要提供API密匙或者 临时 授权令牌。

根据以下步骤，创建新的API密匙：

1. 前往 设置 选项
2. 进入 集成 选项卡
3. 点击 添加API密匙 按钮

使用已获得的 API密匙 参数，位于API其它所有调用的头文件当中：

POST /rest/login HTTP/1.1

Host: https://www.webbsc.com

Content-Type：application/json

Token： replace_with_obtained_token

为计分卡和KPI获取IDs

与KPI相关的API调用，要求提供计分卡ID以及KPI的GUID。

获取计分卡ID

想要找到计分卡ID，可以使用 API 调用 或手动查找。手动查找计分卡ID的方法如下：

1. 前往 我的计分卡 选项
2. 打开目标计分卡
3. 计分卡的URL显示为类似： https://www.webbsc.com/s/123456
4. 末尾数字代表计分卡的ID

获取KPI GUID

想要查找KPI GUID，可以使用 API调用 或手动输入。手动查找GUID方法如下：

1. 打开计分卡
2. 选择 工具 > 导出指标值
3. 根据步骤前往 预览导出结果 页面
4. GUID 列在预览表格中显示，将包含KPI的GUID

使用API读写值

使用 KPI值控制器 进行KPIs数据读写。

• 记得使用 令牌 ，位于请求头文件中
• 数据格式需采用 yyyy-MM-dd 格式（比如“2017-06-30”）
• 数据以JSON格式发送和接收
• 使用批处理调用，将调用数量最优化
• 要读取分组值、计算值或继承值，请使用 分组值控制器

检查 php示例 API使用情况。