Appearance
标识符说明
显示名称、硬件设备 ID、数据库 ID 和数据标识用途不同。API 中使用哪一种,应按对应接口的路径和字段说明选择,不能从显示名称或网址片段推算。
组织与项目
| 标识 | 获取位置 | 用途 |
|---|---|---|
组织标识 slug | 组织设置 → 基本设置中的组织 ID | API 请求头 X-Organization-Slug、组织网址 |
项目 ID project_id | 项目卡片或基本设置 | API 项目路径、项目定位 |
组织标识在创建时填写,创建后不能通过基本设置修改。组织名称和项目名称是显示名称,修改名称不等于更换标识。
设备
设备信息区显示设备 ID 和内部 ID。API 响应还包含数值主键 id。
| 字段 | 含义 | 示例用途 |
|---|---|---|
serial_number | 硬件序列号,对应绑定时的设备 ID | 与安全码一起绑定设备 |
id | 设备数值主键 | /projects/{project_id}/devices/{id}/ 等设备接口 |
agri_id | 设备内部数据标识 | 数据关联与路由 |
不能把 agri_id 替代所有设备接口中的数值 id。详见设备 API。
点位
点位包含数值主键 id 和内部标识 agri_id。
- 配置、阈值和控制接口中的
/points/{id}/使用该接口要求的点位主键。 - 历史数据与自动化条件中的点位标识,按对应字段读取
agri_id或point_agri_id。 - 数据转发中的点位字段应按收到的数据格式解析,不能仅凭字段名与页面 URL 推断。
点位内部标识与设备、从站和寄存器配置相关。复制、更改通信参数或转移设备后,检查外部系统是否仍引用原点位标识。
对接前检查
从平台或 API 复制标识,保持原始大小写和字符。测试请求时同时核对组织、项目、设备及点位,避免把一个组织中的主键用于另一组织。
具体字段见开放 API 字段参考。
