1. Open
云智联开放接口
  • 开放接口
    • Open
      • 使用说明
      • 测试接口
        GET
      • 获取所有设备
        GET
      • 获取设备列表/页
        GET
      • 获取设备详情
        GET
      • 获取设施值历史
        GET
      • 发送指令
        POST
      • 获取指令详情
        GET
      • 获取指令列表/页
        GET
    • 数据模型
      • Volo.Abp.Application.Dtos.ListResultDto`1[[YZLP2.Api.Services.Dtos.OpenDeviceSimpleDto, YZLP2.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]
      • Volo.Abp.Application.Dtos.PagedResultDto`1[[YZLP2.Api.Services.Dtos.OpenCommandDto, YZLP2.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]
      • Volo.Abp.Application.Dtos.PagedResultDto`1[[YZLP2.Api.Services.Dtos.OpenDeviceDto, YZLP2.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]
      • YZLP2.Api.Services.Dtos.OpenCommandDto
      • YZLP2.Api.Services.Dtos.OpenDeviceDto
      • YZLP2.Api.Services.Dtos.OpenDeviceSimpleDto
      • YZLP2.Api.Services.Dtos.OpenFacilityDto
      • YZLP2.Api.Services.Dtos.OpenFacilityValueDto
      • YZLP2.Common.Dtos.ValueListDto`1[[YZLP2.Api.Services.Dtos.OpenFacilityValueDto, YZLP2.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]
      • YZLP2.Api.Services.Dtos.SendOpenCommandDto
      • YZLP2.IoT.Commands.CommandStatus
      • YZLP2.IoT.Commands.CommandType
      • YZLP2.IoT.Commands.Dtos.SendCommandResultDto
      • YZLP2.IoT.Devices.DeviceStatus
      • YZLP2.IoT.FacilityTemplates.FacilityValueType
      • YZLP2.IoT.Facilitys.Dtos.GetFacilityValueHistoryDto
      • YZLP2.Mvc.Models.ApiResult`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
      • YZLP2.Mvc.Models.ApiResult`1[[YZLP2.Api.Services.Dtos.OpenDeviceDto, YZLP2.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]
  • OPEN API
    • 数据模型
      • Volo.Abp.Application.Dtos.ListResultDto`1[[YZLP2.Api.Services.Dtos.OpenDeviceSimpleDto, YZLP2.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]
      • Volo.Abp.Application.Dtos.PagedResultDto`1[[YZLP2.Api.Services.Dtos.OpenDeviceDto, YZLP2.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]
      • YZLP2.Api.Services.Dtos.OpenDeviceDto
      • YZLP2.Api.Services.Dtos.OpenDeviceSimpleDto
      • YZLP2.Api.Services.Dtos.OpenFacilityDto
      • YZLP2.Api.Services.Dtos.OpenFacilityValueDto
      • YZLP2.Common.Dtos.ValueListDto`1[[YZLP2.Api.Services.Dtos.OpenFacilityValueDto, YZLP2.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]
      • YZLP2.IoT.Devices.DeviceStatus
      • YZLP2.IoT.FacilityTemplates.FacilityValueType
      • YZLP2.IoT.Facilitys.Dtos.GetFacilityValueHistoryDto
      • YZLP2.Mvc.Models.ApiResult`1[[System.String, System.Private.CoreLib, Version=9.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
      • YZLP2.Mvc.Models.ApiResult`1[[YZLP2.Api.Services.Dtos.OpenDeviceDto, YZLP2.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]
  1. Open

使用说明

使用说明#

使用流程#

如需使用 API，请先在微信小程序（云智联YZL） [我的] -> [开放接口] 创建 APIKEY。

地址#

https://open.yzlkj.com

请求头#

YZLIOT-APIKEY : 你的 apikey

返回数据结构#

code: 状态码，0 为成功。
data: 返回数据，数据内容因接口而异。
time : 服务器时间。

状态码#

状态码说明
0成功
400参数错误
401未授权/无效APIKey
403权限不足
429请求频率超限
500服务器错误

限制#

并发 2
接口路径限制速率
获取所有设备GET /open/device/all10次/10秒
获取设备列表GET /open/device/list5次/10秒
获取设备详情GET /open/device/{id}10次/10秒
获取历史数据GET /open/history6次/30秒
发送指令POST /open/command/send2次/5秒
获取指令详情GET /open/command/{id}2次/5秒
获取指令列表/页GET /open/command/list2次/10秒

安全策略#

为保障服务稳定性，系统会对异常请求行为实施自动防护措施：
触发条件：当同一 IP 在短时间内频繁返回非 0 状态码（如 400、401、403、429 等）时，将被判定为错误请求。
封禁措施：触发条件的 IP 将面临永久封禁。
建议：
请确保 APIKEY 有效，避免因认证失败触发大量 401。
接口调用失败时，应采用指数退避重试策略（如等待 1s、2s、4s…），切勿在短时间内反复重试相同请求。
定期监控接口返回状态码，及时发现并修复代码或配置问题。
封禁仅针对请求来源 IP，不影响其他 IP 的正常访问。如需解封或申诉，请联系平台客服。

使用场景#

设备数据同步#

通过轮询获取所有设备列表，判断设备最后修改时间，增量拉取设备详情，实现本地数据与平台数据的同步。
同步流程#
1.
获取所有设备
调用 GET /open/device/all 接口获取所有设备，获取当前 APIKEY 下的所有设备基础信息，包含设备 ID、名称、型号、状态及 latestModificationTime（最后修改时间）。
2.
识别变更设备
对比本地存储的设备记录与接口返回的 latestModificationTime。若远端时间晚于本地记录，则判定该设备需要更新。
3.
拉取设备详情
针对每个需要同步的设备，调用 GET /open/device/{id} 接口获取设备详情，获取完整设备详情，包括设备基础信息和设施集（facilitys）。
4.
更新本地数据
将最新设备详情更新至本地数据库，完成一次增量同步周期。
同步建议#
建议项说明
轮询间隔建议设置为 5 分钟、10 分钟或半小时，根据业务实时性要求调整
首次同步本地无数据时，可先调用 /open/device/list 分页拉取全量设备详情作为初始数据
性能优化先通过 /open/device/all 快速筛选变更设备，再按需调用详情接口，避免全量拉取

后续可能会调整的说明#

本文档及对应 API 接口可能会根据业务发展、技术演进或法律法规要求进行不定期调整。调整内容可能包括但不限于：
新增或废弃接口
修改请求/响应数据结构
调整速率限制策略
变更认证方式或请求头规范
我方会尽量在调整前通过公众号公告、或小程序通知等方式提前告知，但紧急调整（如安全修复）可能无法提前通知。
请开发者定期关注文档更新，并合理设计系统以兼容未来可能的变更。对于因未及时适配接口调整而导致的问题，我方不承担相关责任。

免责说明#

本 API 服务按“现状”和“可用”基础提供，不提供任何形式的明示或暗示保证，包括但不限于对适销性、特定用途适用性、不侵权及稳定性的保证。
使用本 API 所产生的任何风险由用户自行承担。在适用法律允许的最大范围内，我方不对因使用或无法使用本 API 所导致的任何直接、间接、偶然、特殊或后果性损失（包括但不限于数据丢失、业务中断、利润损失等）承担责任。
用户应自行做好数据备份与系统容灾，并根据自身业务需求评估接口调用风险。
更新于：2026年7月25日
修改于 2026-07-25 14:02:18
下一页
测试接口
Built with