本指南简要说明如何在 ConnectedCooking 中开始使用 REST API。请注意,本指南仅适用于我们的云 REST API 解决方案。
- 首先,您需要在 ConnectedCooking 账户中创建一个 API 客户端。因此,我们在 ConnectedCooking 帐户中导航到管理选项卡。
- 接下来点击 "集成"。只有账户管理员才能看到 API 标签。
- 然后点击 "+ 添加新内容"。
- 在下一张图片中,您需要提供一个 "ALIAS",指定一个 GROUP 并选择一个 API 类型。对于有关 HACCP 和 ConnectedCooking 账户中数据的 API 查询,您需要使用 "Base API "API 类型。填写完所有栏目后,点击 "添加 API"。
- 在下一个屏幕中,您将收到 API 客户端凭据。请将其妥善保管并点击关闭。
- 创建 API 客户端后,您需要一个工具来使用它。为此,你可以使用 curl、Postman 或其他任何你熟悉的工具。在本指南中,我们使用 Postman。
- 请通过应用程序或浏览器启动 Postman。然后通过 "+"符号创建一个新的空白集合,然后点击 "添加请求"。或者,也可以直接点击 "新建",创建一个新的 HTTP 请求。
- 此外,您还必须将新创建的请求编辑为 POST 请求,以便借助 ConnectedCooking 的 API 客户端凭据接收承载者令牌。
- 因此,您必须查看 API 文档身份验证 | ConnectedCooking 帮助中心
- 文档解释说,您必须创建一个承载令牌,以验证进一步的 API 请求。
- 这是通过 POST 请求实现的。POST 请求使用端点:https://app.connectedcooking.com/api/auth/access
- 此外,您还必须在请求的 body 标签中设置 Content-Type "x-www-form-urlencoded"。然后,必须将 API 客户端中的用户名、密码和范围插入可用列中。
- 最后点击 "发送",就会收到 "accessToken = BearerToken"。
- 要使用新创建的 BearerToken,您需要使用任何 API。
- 您可以在端点文档中轻松查看所有可能的 API 请求:终端 | ConnectedCooking 帮助中心
- 例如,尝试使用设备列表 Endpoint。
- 这个请求非常简单,你只需使用 "https://app.connectedcooking.com",并在其中添加"/api/public/devices",然后在授权选项卡中复制/粘贴 POST 请求中的 "accessToken",如下图所示。你只需在 Auth 类型中选择 "Bearer Token"(承载令牌),然后令牌字段就会出现。
- 最后点击 "发送",您将收到 ConnectedCooking 账户中所有已注册设备的列表(如果账户中没有设备,该列表为空)。
这个例子基本上可以应用于所有端点。
恭喜您,现在您可以使用 ConnectedCooking 的 REST API 了!
如果您需要更多信息,请查看我们的 ConnectedCooking API 文档:简介 | ConnectedCooking 帮助中心