文档中心
业务接入
接入指南
接入业务常用场景
开发文档
开发常见步骤
常用场景开发指南
API文档
接入指南

步骤


  • 创建用户基本信息

    登录开放平台,进入开发者服务>开发者>基本信息填写,根据您的真实情况填写基本信息,以便我们尽快了解您。请填写正确的开发者邮箱地址,以便我们将最新的公告以及SDK更新内容及时发送给您。

    建议合作伙伴以公司形式填写基本信息。

  • 创建应用

    进入开发者服务>我的应用,点击创建应用,创建过程中请详细填写应用的每一栏,因为这样能让我们尽快了解您的应用,并关注到您的应用。

  • 下载SDK和接口文档

    针对PC和移动端,我们应用提供了PC、Android、iOS三个版本的SDK,同时提供萤石云平台接口调用。请前往下载下载SDK和接口文档,针对于不同客户端的应用,我们提供了相应的用户手册和Demo供开发者参考。

  • 应用开发、测试

    合作伙伴在此期间根据自身业务场景进行应用开发。应用接入场景可查看文档中心>接入业务常用场景一栏。开发过程中可参考文档中心>开发文档一栏。


  • 萤石开平定时会进行版本更新,每次迭代的更新内容请见系统公告或开发者邮箱,请开发者定时关注。萤石团队时刻虚心等待着您宝贵的建议,如果您在开发接入、产品使用过程中有好的建议或想法可邮件方式联系下方的开平管理员,谢谢!

接入业务常用场景
接入业务常用场景
接入业务常用场景
接入业务常用场景
  • 智能家居相关
  • 教育,连锁相关
  • 直播地址接入

典型场景描述


如果您需要开发一套基于家庭智能生活的综合型App应用,如物联平台、家庭监控、老人远程照顾、宠物在线等,可选择智能家居的接入方式。

应用场景分析


您的用户可以在开发的app中添加萤石设备,支持视频直播、视频回放、报警接收、语音对讲等功能。

场景特点


温馨提示:选择智能家居方式,萤石设备的所有权和访问权限都只属于您的用户。 详细请参阅《智能家居接入步骤和指南》

典型场景描述


以教育机构视频监控系统中的幼儿园”宝宝在线“做典型场景,某幼儿园有十个教室,每个教室有2个萤石摄像头,幼儿园管理员有这20个萤石设备的拥有权。幼儿园开发了一套用于家长看自己孩子教室学习情况视频的app,家长在此app上注册账号,幼儿园管理员分配相应教室的摄像头预览权限给此家长账号。家长登录app后,就可以看自己孩子所在教室的设备的实时视频。

应用场景分析


以上描述的”宝宝在线“场景可广泛适用于其他的业务场景,如连锁店监控、市场管理监控、养殖监控、在线课堂、校园监控等等。

场景特点


设备归属于创建应用的管理员,即所有设备都与此管理员在萤石平台的萤石账号绑定。家长没有对设备的拥有权,但是通过第三方系统的权限分配,可以看到某一个设备的视频。详细请参阅《教育连锁接入步骤和指南》

典型场景描述


典型场景一:某商场要做一个现场直播活动,开发者将直播地址嵌入到H5页面,将页面放入其官方微信公众号,并将直播页通过微信分享的方式广泛传播。所有收到微信分享卡片的用户都能打开此页面进行直播观看。

典型场景二:某幼儿园需要在其官方网站上公开展示孩子们在教室的活动、学习场景,幼儿园管理者可将视频直播地址嵌入到此幼儿园的官方网站,以提供家长或者社会人士实时查看。

应用场景分析


视频直播地址,可以轻松让您拥有互联网视频直播的能力,让您的微信公众号、网站内容更加丰富。实现交通路况、生态农业养殖、商铺环境可视化营销、幼儿园宝宝在线实时直播等在线视频应用,打造属于您自己的商业模式。

场景特点


开发者可以方便、快捷地将直播地址嵌入到Web网页、手机网页或微信服务号中,用以实现丰富多彩的应用主题。详细请参阅《直播地址接入步骤和指南》

开发常见步骤
  • C/B用户场景区分
  • 开通萤石服务
  • 了解Demo

前言


第三方应用接入开放平台,从用户、应用场景角度来分析,主要有智能家居和教育连锁两种基本业务场景,可定义为C用户模式(智能家居)和B用户模式(教育、连锁等),当然第三方应用可能既有C模式又有B模式的业务场景。应用开发者可以根据自身业务出发确定使用的是哪种模式。

注:开放平台为第三方应用提供的业务场景不止C用户模式和B用户模式这两种模式,如还有直播地址接入等场景。

C模式(智能家居模式)介绍


C模式典型案例

A公司开发一套基于个人智能生活的综合性app应用,并支持接入萤石的IPC相关产品。其下用户购买萤石的设备,在此app中添加萤石的设备,并且进行预览、回放、报警接收等功能。

C模式典型业务分析

设备属于app终端用户,即C用户拥有设备所属权。

从开发者开发app的角度出发,可以这么理解,调用SDK接口所传的accessToken是C用户的accessToken(这是跟下面介绍的B模式的最大区别)。

C模式接入流程

为实现C模式业务,开发者需要实现以下主要对接流程:

1.  账户对接。账户对接的目的是第三方为C用户在萤石云平台创建一个萤石账户。账号对接完成后,第三方才能获取C用户的accessToken,进行后续的SDK接口调用。
     目前账户对接有两个方案:
     a.使用萤石标准OAuth协议。
     b.私有云-萤石云账户对接授权。
     方案a主要针对无账户体系的第三方开发者。
     方案b主要针对本身有账户体系,并且具有后台开发、对接能力的第三方开发者。
     具体账户对接方案请查看《智能家居场景账号对接》流程。

2.  设备添加。使用开放平台的SDK,扫描二维码->进行wifi配置->调用SDK的添加设备接口打开添加页面->添加后即完成C用户与设备在萤石平台的绑定。

3.  预览。此时使用C用户的accessToken调用SDK的预览接口,C用户就能在app上实时预览自己的设备视频。

B模式(教育、连锁模式)介绍


B模式典型案例

教育机构视频监控系统。以幼儿园为例,某幼儿园有十个教室,每个教室有2个萤石摄像头,幼儿园管理员有这20个萤石设备的拥有权。幼儿园开发了一套针对家长的app,家长在app上注册账号,幼儿园管理员分配相应教室的摄像头预览权限给家长账号。家长登录app后,就可以看自己孩子所在教室的设备的实时视频。

B模式典型业务分析

设备属于第三方应用管理员,即所有设备都与此管理员在萤石平台的账号绑定。

从开发者开发角度出发,可以这么理解,调用SDK接口所传的accessToken是管理员账户的accessToken,而其应用下面的用户与设备的绑定关系全由开发者根据业务场景自己来控制。

注:针对于B模式使用场景,设备只能绑定(即添加)在萤石开放平台申请应用时使用的那个萤石账号下面,请详见《教育连锁账号对接》

智能家居场景账号对接


模式一:使用萤石标准

使用萤石标准OAuth协议,开发量比较小,第三方应用直接使用萤石的登陆、注册页面,对于没有账号体系或没有后台服务的应用优先可以采用这种对接模式。

具体实现,可以参考客户端SDK Demo中的实现方式,使用萤石登陆页面登陆成功后,客户端SDK会返回AccessToken给第三方应用。

第三方应用可通过拿到的accessToken,调用萤石平台获取用户基本信息接口得到用户的基本信息,基本信息中包括返回一个萤石用户唯一标示id(ysid),第三方可将此ysid与自己平台的用户进行绑定。

OAuth错误码集合如下:

错误码含义
1001萤石账号不存在
1002密码错误
1003验证码错误
1004用户被冻结
1005需要短信验证码
1007参数错误
1008无权限
1010服务暂停
1014应用不存在
1015第三方应用未通过审核

模式二:调用SDK接口开通萤石服务

第三方应用调用萤石开放平台(简称“开平”)后台接口(萤石平台接口使用说明文档“第三方获取用户accessToken”接口)获取用户的accessToken,若第三方应用的用户已经开通萤石服务,跳过流程一,进入流程二获取用户accessToken。若未开通萤石服务,调用获取“第三方获取用户accessToken”接口会返回“10011”错误码,需进行流程一的开通萤石服务流程。

流程一:第三方应用的用户没有开通过萤石服务,则进行开通萤石服务的流程。
流程二:第三方应用的用户已经开通过萤石服务,第三方后台直接调用开平接口获取用户accessToken。

详见以下流程图:

流程一

注1:详细请见《萤石平台接口使用说明文档》第三方获取用户accessToken接口。

流程二

教育连锁账号对接


该场景设备属于在开放平台创建应用的管理员,管理员分配其下的设备给其下特定的用户使用,用户的客户端在调用SDK接口的时候传的accessToken是管理员的accessToken。

着重说明下这里的管理员账号是指在开放平台申请应用的那个萤石账号。

前言


应用开发·SDK下载,可以下载到最新的Android、iOS、PC端的开发SDK。同时,针对于不同客户端的应用,开放平台都提供了相应的Demo供开发者参考,并且在Demo中基本涵盖了目前萤石开平可以提供给第三方应用的能力级,以下几点是开发者在看Demo源码或者使用Demo的时候需要注意的。

一、关于Demo源码中的App Key


Demo源码中需要使用到开放平台的APP Key,默认写在里面的是无效的App Key,开发者使用Demo前需先把APP Key换成自己申请应用对应的值,然后编译Demo程序。

二、关于Demo中实现的功能


在Demo中实现了目前开放平台提供给开发者的所有功能展示。针对于Demo中的一些UI或功能模块,开发者既可以在这基础上进行改造,也可以重写。

目前SDK主要提供功能如下:

1.  完整的萤石设备添加功能。设备添加的功能建议第三方应用直接使用Demo实现的流程。扫描设备后面的二维码或手动输入设备序列号->输入设备验证码->自动配置wifi->完成。

2.  用户设备列表的获取。Android、iOS、PC的开发SDK中实现了获取用户设备列表的接口,但是萤石平台http接口(详见:《萤石平台接口使用说明文档》)也实现了获取用户设备列表的接口,建议以后者的方式获取设备列表。

3.  实时视频预览、录像回放,属于萤石开平提供给第三方的核心功能。

4.  获取报警消息列表。

5.  报警推送接收。此功能iOS版本的SDK暂时不支持,如果iOS想实现报警推送,建议使用定时调用萤石接口拉去报警消息。

6.  设备操作。具体操作如设备基本信息展现、设备升级功能、活动检测提醒开关、视频图片加密开关等。

常用场景开发指南
  • 智能家居接入步骤和指南
  • 教育连锁接入步骤和指南
  • 直播地址接入步骤和指南

账号对接


您需要将用户和萤石平台进行账号绑定:

详细请参阅《智能家居场景账户对接》流程和《萤石平台接口文档》

设备连接


针对萤石不同设备可选择有线连接和无线连接:

1.  有线连接:用网线将设备接入路由器。

2.  无线连接:调用SDK wifi配置接口。

添加设备


调用SDK“设备添加”接口,打开设备添加中间页,可选择扫描设备二维码添加和手动输入设备序列号添加。

视频预览


调用SDK 预览相关接口,实时预览设备视频。

视频回放


调用SDK 回放相关接口,回放报警录像和云录像(设备需有存储介质或开通云存储服务)。

报警接收


调用SDK 报警推送接口,获取实时报警消息、设备下线消息等推送消息。

设备操作


调用SDK 设备操作接口,打开设备操作页,完成设备加密、活动检测提醒等设备操作。

以上介绍了智能家居场景接入萤石设备的基本步骤,其他更多的功能接口请查阅《SDK下载文档》

幼儿园场景


设备绑定


设备属于创建应用的管理员(幼儿园),即所有设备都与此管理员在萤石平台的账号绑定,管理员可以通过萤石客户端添加设备,或者调用SDK接口添加设备。

账号对接


该场景账号对接流程请参阅:《教育连锁场景账户对接流程》

权限分配


管理员根据业务场景来控制其下用户(家长)对设备的权限,但其下用户客户端调用SDK接口所传的accessToken统一为管理员账户对应的accessToken。

视频预览


调用SDK 预览相关接口,实时预览设备视频。

视频回放


调用SDK 回放相关接口,回放报警录像和云录像(设备需有存储介质或开通云存储服务)。

添加设备


萤石云或者萤石客户端添加设备至开发者账号下,并确保设备的视频图片加密开关是关闭的。

购买地址


开发者服务>互联网直播>直播管理创建直播,选择相应的套餐,支付成功后,填写需要绑定的设备通道号(即视频源),即可提取直播地址。

使用地址


拿到直播地址后,可以选择web页面或H5的方式嵌入,具体例子可参考嵌入例子