产品间接口规范说明书.docx
《产品间接口规范说明书.docx》由会员分享,可在线阅读,更多相关《产品间接口规范说明书.docx(14页珍藏版)》请在得力文库 - 分享文档赚钱的网站上搜索。
1、目录目录1 简介简介.21.1 缩略语和术语.22 接入前准备接入前准备.32.1 申请 APPID 和 APPKEY.3 2.1.1 应用联运接入帐号.3 2.1.2 快应用接入帐号.3 2.2 SDK 导入.43 必要说明必要说明.43.1 应该选择哪种授权模式.44 账户授权功能接入账户授权功能接入.54.1 授权码/标准授权方式.5 4.1.1 客户端调用 SDK 获取授权码 Code【Client 对接】.7 4.1.2 应用服务器根据 code 获取 AccessToken 和 RefreshToken【服务器对接】.8 4.1.3 根据 AccessToken 获取用户授权信息【
2、服务器对接】.9 4.1.4 根据 RefreshToken 获取新 AccessToken 【服务器对接】.11 4.2 简化授权方式不推荐.125 账户开放功能功能接入账户开放功能功能接入.135.1 通过 AccessToken 获取用户信息【Client 对接】.13 5.2 编译防混淆方法.146 附录附录-服务器签名算法服务器签名算法.146.1 MD5 签名.14 6.2 MD5 签名工具.157 FAQ.151 简介简介本文档描述了 vivo 授权接口的使用说明。1.1 缩略语和术语缩略语缩略语/术语术语全称全称说明说明clientid 第三方服务 IDclient_id 是
3、vivo 标识对第三 方的唯一性标识,就是在接 入前申请的 appid 做为 clientidclientsecret 第三方服务器密钥第三方访问 vivo 的密钥,用 于签名,不能在公网中传输, 在接入前申请的 appkey 做为 clientsecretaccesstoken 访问令牌在用户授权许可下,授权服 务器下发给客户端的一个授 权凭证,可以用 access token 获取用户授权的信息refreshtoken 刷新令牌刷新令牌的作用在于更新访 问令牌,访问令牌的有效期 一般较短,这样在访问令牌 失效时,可以利用刷新令牌 去授权服务器换取新的访问 令牌,是否需要该令牌是由 第三方自
4、行选择redirecturi 回调地址回调地址作用主要体现在 PC 端接入授权: OAuth2.0 是一类基于回调的 授权协议,在授权码模式中, 整个授权需要分为两步进行, 第一步下发授权码,第二步 根据第一步拿到的授权码请 求授权服务器下发访问令牌。 OAuth 在第一步下发授权码 时,是将授权码以参数的形 式添加到回调地址后面,并 以 302 跳转的形式进行下发一般回调地址都是根据 H5 自身的业务配置,如果某个 业务仅仅有 apk,而没有 PC接口规格说明书第 3 页缩略语缩略语/术语术语全称全称说明说明端的授权业务,可以简单配 置为该公司的相关主域名注意:开发者平台里面注意:开发者平台
5、里面“回回 调地址调地址”需要填写回调域名,需要填写回调域名, 而不是具体的回调地址,回而不是具体的回调地址,回 调域名必须严格是调域名必须严格是 scheme:host 形式,不能加路形式,不能加路 径。径。https 和和 http 是不同是不同 scheme,不可混用。,不可混用。 eg: http:/ https:/ 可用于配置开发者平台。而 https:/ 不可以配置在开发者平台接入 vivo 第三方授权之前,需要提前申请 APPID、APPKEY、回调地址(redirectUrl) ,申请 流程详见 2.12 接入前准备接入前准备2.1 申请 APPID 和 APPKEY2.1.1
6、 快应用接入帐号 联系与您对接的商务(对内直接联系张秋云) ,说明需要接入 vivo 帐号的快应 用。 提供您的快应用名称,快应用包名,开发者平台帐号,快应用 icon,回调地 址给到对应商务。 从商务处获取 appid 与 appkey 数据。2.2 游戏接入方式游戏接入方式不需要接任何 SDK,直接调用 API 即可: http:/ 4 页3 必要说明必要说明3.1 应该选择哪种授权模式应该选择哪种授权模式我们提供了授权码/标准模式、简化模式两种方案供开发者选择。(1)授权码模式授权码模式/标准模式(标准模式(authorization code)是功能最完整、流程最严密的授权模式。 它的
7、特点就是通过客户端的后台服务器,与“服务提供商“的认证服务器进行互动。(2)简化模式(简化模式(implicit grant type)不通过第三方应用程序的服务器,直接在浏览器中向认 证服务器申请令牌,跳过了“授权码“这个步骤,因此得名。所有步骤在浏览器中完成,令牌 对访问者是可见的,且客户端不需要认证。这两类模式各有自己的应用场景,在选择上除非您的应用没有服务端,否则我们强烈建议你 选择使用授权码模式授权。相对于简化模式来说,虽然授权码模式多了一次请求,但是在授权码模式下可以基于 clientsecret 来验证 APP 的真实性,同时授权码模式会下发刷新令牌,当访问令牌过期时可 以通过刷
8、新令牌在后台静默更新访问令牌,而无须再次让用户授权而无须再次让用户授权。4 账户授权功能接入账户授权功能接入账户 SDK 提供了标准授权和简化授权两种方式4.1 授权码授权码/标准授权方式标准授权方式标准授权方式,授权 SDK 给应用返回授权 Code,应用需要将 Code 传给应用自己的业务服务 器,业务服务器再访问账户服务器获以获取 AccessToken 和 RefreshToken1.标准授权方式流程图如下:接口规格说明书第 5 页应用账户SDK应用服务器账户服务器1、调用RequestCode2、返回code3、客户端请求业务服务器,带上code4、业务服务器请求账户服务器5、账户服
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 产品 间接 规范 说明书 仿单
限制150内