模块ID
- 模块ID是对接中的重要ID标识,几乎所有的接口中都需要用到;
- 模块ID时创建模块的时候有SKY平台自动生成的唯一ID,只可以用,不可以更改;
- 在后续的接口文档中,通常以参数名
moodid或者mod来传递。
签名算法
- 签名算法是开发者系统与SKY平台交互数据时,进行签名和验签所需要用到;
- 目前支持的算法有:
MD5,SHA1,SHA256,SHA1withRSA,SHA256withRSA; - 开发者可以自行选择需要支持的算法,并且配置密钥,以便系统的灵活运用;
- 具体的数据签验方式,请参考附录:签名算法。
登录回跳地址&方式
- 用户在登录页面上登录成功后,会回跳到开发者系统;
- 配置好回跳地址后,SKY平台才会知道登录成功后跳转的具体地址;
- 跳转到这个地址的跳转的方式可以分为GET方式或POST方式。
地址中的voucher参数
- voucher参数是指登录凭证,在调用凭证校验接接口时用到;
- 当配置跳转的方式为GET回跳时,必须在地址中预留
{voucher}标记; - SKY平台会把标记替换成实际的值,然后跳转到开发者系统中;
- voucher的值为一次性使用且有效时间为1分钟,当校验过或者超时后则失效。
地址参数可参考一下方式配置(可根据开发者系统的技术选型而定):http://your-domain/login.html?voucher={voucher}http://your-domain/login/{voucher}http://your-domain/aaa/bbb#v={voucher}
替换后的地址形式如下(假设voucher的值为abc123):http://your-domain/login.html?voucher=abc123http://your-domain/login/abc123http://your-domain/aaa/bbb#v=abc123
提示:
在一些特定场景下,开发者系统可能也会需要获取modid参数(比如:创建了2个模块而回跳地址为同一个),此时可以在回跳地址中写死模块ID,以满足开发需求。
(假设模块ID为abcdef)如:http://your-domain/login.html?modid=abcdef&voucher={voucher}
POST方式&GET方式
可根据自己的需求选择GET方式或POST方式,两者的区别在于:
- POST方式是以HPPT协议的POST请求方式,将当前登录者的各种信息提交到指定的地址中;
- GET方式只会带上一个voucher参数,并请求指定的地址,拿到voucher参数后,需要在后端调用“凭证校验”接口来获取当前登录者的何种信息。
前者较为简单方便,但是会把信息暴露在浏览器中;后者稍微麻烦一点,但是数据保密性较高。
消息服务地址
SKY平台会把一些重要的信息发送给您的系统,通过配置消息服务地址来收取信息;
消息分为两种类型:一种为通知,另一种为事件。
两者的区别在于:
通知是一些对及时性要求比较低的信息,可能会延迟数秒钟时间发送,且不需要返回任何结果给SKY平台,如:登录通知等。
事件是一些重要的信息,并且需要立即返回结果告知SKY平台,如:注册事件,密码校验事件等。
以注册事件为例子:
- 开启注册功能后,当用户在SKY平台提交注册后,SKY平台会发送注册事件到开发者系统消息服务地址;
- 注册事件中包含了用户注册的全部信息,开发者系统收到注册事件后,可能需要进行数据核查,比如判断用户名是否已经被注册等;
- 然后需要返回结果告知SKY平台能否继续注册,如果返回拒绝注册或等待时间超时,SKY平台则会提示注册失败。
登录页面地址
- 页面地址由SKY平台自动生成,可供开发者系统登录用,不可能更改;
登录模式
待完善。。。