萤石社区 门户 开发前必读 查看内容

如何使用开放平台的API文档

2024-7-30 10:41| 发布者: 9zo1wx| 查看: 4472| 评论: 0

摘要: 如何使用开放平台的API文档
萤石开放平台的API文档分为三个大类:产品文档,API接口文档SDK文档

产品文档主要介绍该产品功能及使用方法,一般为操作类文档(不涉及开发),此部分内容建议在开发前了解产品时阅读;

API接口文档包含了平台全部的接口,按照产品大类区分,需要找特定功能接口时请查阅此部分文档;

SDK文档包含了针对不同端的SDK软件开发包,当需要集成到客户端时可以直接使用SDKSDK软件开发包通常包含播放/暂停(直播、回放),对讲,截图,云台等基础功能。

 

下面将列举一些常见功能

l  设备相关服务

l  取流相关服务

l  设备消息服务

一、设备相关服务

1.      通用设备能力指设备接入平台后对设备的管理功能。例如:设备添加与删除、设备确权、设备管理(修改设备名称,修改通道名称)、设备信息查询(查询设备列表,获取单个设备状态)等,可在开放平台OPEN API的云接入-通用设备管理下找到:https://open.ys7.com/help/659


2.      设备能力指平台下发指令给设备以实现特定功能,例如云台接口(云台控制,镜像翻转,预置点等),抓拍等接口可在开放平台OPEN API的云接入-设备能力下找到 https://open.ys7.com/help/677


3. 特殊设备的相关接口,比如执法记录仪,安全帽相机,萤石传感设备,萤石智能锁等可在开放平台OPEN API设备云组件仓下找到 https://open.ys7.com/help/738


二、取流相关服务

1. 取流接口,例如:获取播放地址接口,录像文件查询接口等,可在云直播产品概览中找到:https://open.ys7.com/help/1412


2. SDK集成,包含原生应用,轻应用,小程序等多个端的SDK,可在云直播产品概述中找到:https://open.ys7.com/help/1744


三、设备消息服务

设备的告警消息获取,设备的上下线通知推荐使用通过消息推送对接,可在开放平台产品文档下的消息推送查看开通步骤:https://open.ys7.com/help/566


路过

雷人

握手

鲜花

鸡蛋
下一篇:产品使用入门

评论

您需要登录后才可以发表言论 登录立即注册
© 2013-2024 萤石ys7.com 浙ICP备2024101974号-2
关灯 返回顶部
返回顶部