ADI OtoSense REST API

简介

ADI OtoSense SMS REST API 提供一系列操作和资源,包括

  • 可对配备智能电机传感器的电机进行配置。
  • 访问电机数据集,包括分析输出。
  • 检索电机警报详情,包括历史记录。

访问应用程序接口

如果您有一个ADI OtoSense SMS租户,您可以通过租户的ADI 端点访问ADI OtoSense SMS REST API。您可以在ADI OtoSense SMS Web UI 的 "API - 端点 "屏幕上找到您的端点,该屏幕可通过屏幕右上方您的姓名下的菜单中的 API 选项进行访问。

如果您没有ADI OtoSense SMS 租户,请访问otosense并注册生产试用租户。

认证

ADI OtoSense SMS REST API 使用 OAuth v2.0 进行身份验证。

模拟器件公司建议对 API 用户采用最小权限方法。确保只为任何 API 用户分配权限最小的角色。

通过 OAuth 进行身份验证需要以下步骤:

  1. 创建客户端 API 密钥。
  2. 生成令牌。
  3. 提出认证请求。

创建客户

您必须首先在ADI OtoSense SMS UI 中创建一个 API 密钥。为此,您必须是ADI OtoSense SMS 租户的管理员。这是一次性操作。您将获得一个客户 ID 和一个客户密钥。请记下这些信息,因为下一步需要用到。客户 ID 和客户密文应被视为敏感凭证,因此应适当保护,切勿在前端单页应用程序中使用,也切勿提交到源代码中或以其他方式使其可被普遍访问。

注:API 密钥由指定的用户角色管理。该密钥可用的操作由该角色决定。

点击此处查看ADI OtoSense REST API 的完整版本。