产品授权(旧)
一 为什么要授权
授权就像您的身份证一样,是通行的重要凭证,让您的用户或设备可以有效使用智能语音服务;通过“颁发”和“校验”就能轻松完成这个过程。
二 思必驰提供的授权方式
2.1 设备授权
为保障您的设备能正常访问技术服务,设备授权提供动态注册和预烧录两种类型,可同时使用。
其中动态注册为默认设备授权类型,只需设备在注册时提供设备名及其他详细信息进行注册即可,也可预先登记好设备白名单,保证只有白名单内的设备才能激活。点击查看详细操作
下面的信息可以帮助您判断如何选择设备授权类型:
授权类型/能力要求 | 设备联网授权 | 云端能力 | 端上能力 | 支持烧录 | 出厂测试 | 白名单授权 | 建议设备场景 |
---|---|---|---|---|---|---|---|
动态注册 | 需要 | 需要 | 需要 | 不需要 | 不需要 | 不需要 | 能联网的安卓、iOS、嵌入式系统的设备,如音箱、电视、故事机等 |
动态注册(预登记设备白名单) | 需要 | 需要 | 需要 | 不需要 | 不需要 | 需要 | 需要控制只有名单上的设备才能激活,防止被盗用,如多批次发行的设备其中某个批次需要控制 |
预烧录 | 不需要 | 不需要 | 需要 | 需要 | 需要 | - | 有离线场景需求的设备常选用该类型 |
2.2 APP授权
通过申请APIKEY来完成,点击查看详细操作
注意事项:
- APP授权确保您下载的Android/iOS SDK只能运行在指定的APP内;
- 一个APIKEY只被指定的APP使用,如不同包名的Android APP应该使用不同的APIKEY;
- Android和iOS设备在授权时需同时完成APP授权和设备授权;
2.3 服务授权
通过白名单机制来完成对访问IP的控制,点击查看详细操作
服务授权确保在云端对云端的情况下,只有白名单内的IP才能访问服务,仅对API调用方式生效。
三 授权过程的步骤
- 完成控制台产品授权配置
- SDK、API集成授权配置
四 详细操作步骤
当您在使用SDK或API调用思必驰提供的技术服务时,接入前需完成授权配置。本文档介绍如何在控制台完成产品授权配置。
4.1申请授权操作
首先,我们以DUI系统的产品为例,介绍下授权管理的入口;
如果您的产品是全链路或者单项技术,请看下图:
如果你的产品选择了长语音或者机器翻译,请看下图:
4.2 选择所需的授权方式
接下来,您可以结合操作系统的情况来完成对应的申请操作:
- Android设备——设备授权、APP授权
- iOS设备——设备授权、APP授权
- 嵌入式设备——设备授权
- 云端对云端——服务授权
4.2.1 设备授权
(1)动态注册
动态注册授权类型无需在控制台做任何操作,您只需确保设备在注册时能够提供设备名及其他详细信息进行注册即可。
当您需要预先登记设备名保障只有白名单内的设备才能被激活时,请按以下步骤操作:
步骤一:选择预登记设备白名单,您可以提前先下载登记模板提前准备好设备名单;
步骤二:上传设备列表文件;
文件要求:
- 上传的文件格式仅支持txt;
- 请使用设备唯一标识进行登记,设备间标识不可重复,否则会影响使用;
- 请保证每行只有一个设备标识,否则同一行会被作为一个设备标识处理;
步骤三:在第2步完成后,已登记的设备白名单可在列表里查看;
需要注意的是,登记的设备数量不等同于已经激活的数量,只有设备被激活时才会计算到已激活的设备数量里。
(2)预烧录
如果您的设备出厂前不方便联网或者有离线场景需求时,可以在线生成一批许可烧录到指定设备上,申请预烧录的步骤如下:
步骤一:选择申请预烧录,提前准备好设备标识文件,需注意文件里的设备标识数量需小于等于当前产品可激活的设备数量,若可用量不满足时请选择申请用量;
步骤二:上传设备标识文件;
步骤三:下载生成好的设备证书;
4.2.2 APP授权
(1)Android
第一步:申请APIKEY;
Android设备需提交名称、正式/测试SHA256、package,申请成功后即可获得APIKEY:
Q:如何获取SHA256?
A:可参照文档SHA256获取方法
Q:如何获取package?
A:
Eclipse
打开Android 应用工程的AndroidManifest.xml配置文件,package属性所对应的内容为应用PackageName。
Android Studio
获取build.gradle文件中的ApplicationId作为PackageName;如果没有设置ApplicationId,请以AndroidManifest.xml配置文件的package属性为准。
下一步:请按需选择对应的技术文档完成授权配置;
(2)iOS
第一步:申请APIKEY;
iOS设备需提交名称、bundleID,申请成功后即可获得APIKEY:
下一步:请按需选择对应的技术文档完成授权配置;
4.2.3 服务授权
云端对云端的情况需要提交名称、白名单,申请成功后即可获得APIKEY:
请注意:
- IP白名单支持多条,可以填写子网掩码长度模糊匹配网段;
- 输入的IP地址为申请语音服务的机器IP地址,且必须为外网IP;
Q:运行代码示例返回 401 Unauthorized,是什么原因?
A:通常是 apiKey 参数不正确,也可能是运行代码示例的机器外网 IP 不在申请 apiKey 时填写的 IP 白名单中。
Q:我不知道自己外网IP,怎么办?
A:可以访问https://ip.sb/ 获取外网IP地址。如果是Linux 或者 macOSX 的系统,或者没有 GUI 的服务器,可以使用 curl ip.sb这个指令获取到自身的外网 IP。
下一步:完成授权配置;
您需要根据语音请求的接口定义添加相应的参数,请按需选择对应的语音技术文档完成授权配置;