程序包 Seng.Shi.Hou.Duan.Yun.SDK

接口 API

所有已知实现类:

后端云对接类

public interface API

此处定义了后端云所有可供调用的API，您无需关心它具体如何运作，只需要调用它即可

作者:

驻魂圣使

嵌套类概要

嵌套类

修饰符和类型	接口	说明
static interface	API.登录回调
static interface	API.读取公告回调
static interface	API.检查更新回调
static interface	API.解除绑定回调
static interface	API.卡密登录回调
static interface	API.使用卡密回调
static interface	API.收到数据
static interface	API.修改密码回调
static interface	API.注册回调

方法概要

修饰符和类型	方法	说明
String	get原始数据()	读取服务器上一次响应的数据
void	setPinning(boolean pinning)	设置是否启用证书固定 启用证书固定之后，SDK会验证服务器的公钥证书是否可信，可有效防范中间人攻击。
void	setServerPublicKey(String publicKey)	设置服务器的公钥，SDK中已经内置了公钥证书，一般情况下您无需改动。
void	setSign(boolean Sign)	是否开启数字签名，启用此设置后，SDK会校验服务器响应数据的数字签名，用以保证数据安全
void	set证书链(ling.android.操作.okhttp.证书 证书链)	SDK内部已经设置号了服务器的公钥证书，如果服务器更换了公钥证书而没有即使提供新的SDK 那么您可以通过此方法来设置新的公钥证书。
void	登录账号(String 账号, String 密码, API.登录回调 回调)	登录账户，登录的账户必须在后端云中存在，如果登录的账户不存在，那么登录不会成功。
void	读取公告(API.读取公告回调 回调)	读取项目公告
void	检查更新(int 当前版本号, API.检查更新回调 回调)	检查服务器是否有更新版本
void	解绑卡密(String 卡号, API.解除绑定回调 回调)	解除一张卡密绑定的设备，要调用此API需要在圣使后端云客户端内启用项目的单码登录设置且启用设备绑定功能。
void	解绑账号(String user, String pass, API.解除绑定回调 回调)	如果您的项目启用了绑定设备功能 那么您将会需要这个API 此API可以解除账号和设备的绑定 请注意！
void	卡密登录(String 卡号, API.卡密登录回调 回调)	使用卡密直接登录，要调用此API需要在圣使后端云客户端内启用项目的单码登录设置。
void	使用卡密(int 账户ID, String 卡号, String 授权码, API.使用卡密回调 回调)	此方法用于使用卡密 后端云的卡密绑定账户，既卡密的面额在使用之后就加到账户的会员时间之中 使用卡密过后，账户的会员时间会增加，您只需要在登录时判断会员时间戳是否大于当前时间戳即可 无需重复使用卡密 卡密使用过后既销毁，无法重复使用 请注意！
void	修改密码(账户数据类 user_data, String 原始密码, String 修改后的密码, API.修改密码回调 回调)	修改账户的密码
void	注册账号(String 账号, String 密码, String 昵称, String 邮箱, API.注册回调 回调)	注册一个账户到后端云中 您无需检查邮箱格式是否正确 服务器会代您执行检查 或者您可以调用验证码接口验证邮箱合法性
void	注册账号(String 账号, String 密码, String 昵称, API.注册回调 回调)	注册一个账户到后端云中，此如果您的项目设置了必须输入邮箱，那么此方法调不通。
void	注册账号(String 账号, String 密码, API.注册回调 回调)	已过时。

方法详细资料

登录账号

void 登录账号(String 账号,
 String 密码,
 API.登录回调 回调)

登录账户，登录的账户必须在后端云中存在，如果登录的账户不存在，那么登录不会成功。你需要先调用注册API来将账号添加至后端云中，然后登录才能成功

参数:

账号 - 登录账户的账号

密码 - 登录账户的密码

回调 - 回调方法

注册账号

@Deprecated
void 注册账号(String 账号,
 String 密码,
 API.注册回调 回调)

已过时。

注册一个账户到后端云中 此方法用于不需要邮箱的项目，如果您的项目设置了必须输入邮箱，那么此方法调不通 此方法注册的账户会使用默认昵称 使用默认昵称时，后台可能不好区分账户，所以不建议使用此方法

参数:

账号 - 账号

密码 - 密码

回调 - 回调方法

注册账号

void 注册账号(String 账号,
 String 密码,
 String 昵称,
 API.注册回调 回调)

注册一个账户到后端云中，此如果您的项目设置了必须输入邮箱，那么此方法调不通。

参数:

账号 - 账号

密码 - 密码

昵称 - 昵称

回调 - 回调方法

使用卡密

void 使用卡密(int 账户ID,
 String 卡号,
 String 授权码,
 API.使用卡密回调 回调)

此方法用于使用卡密 后端云的卡密绑定账户，既卡密的面额在使用之后就加到账户的会员时间之中 使用卡密过后，账户的会员时间会增加，您只需要在登录时判断会员时间戳是否大于当前时间戳即可 无需重复使用卡密 卡密使用过后既销毁，无法重复使用 请注意！使用卡密之后您需要重新调用登录接口获取账户最新数据！！

参数:

账户ID - 要激活的账户的ID，您可以调用登录回调传入的账户数据类中的getID()方法来获取 ,注意！您只能获取到当前登录用户的ID，后端云中没有提供获取他人ID的API

卡号 - 要使用的卡号，卡密不可重复使用，一张卡密只能一个账户使用，卡密使用过后即可丢弃

注册账号

void 注册账号(String 账号,
 String 密码,
 String 昵称,
 String 邮箱,
 API.注册回调 回调)

注册一个账户到后端云中 您无需检查邮箱格式是否正确 服务器会代您执行检查 或者您可以调用验证码接口验证邮箱合法性

参数:

账号 - 账号

密码 - 密码

昵称 - 昵称

邮箱 - 邮箱

回调 - 回调方法

检查更新

void 检查更新(int 当前版本号,
 API.检查更新回调 回调)

检查服务器是否有更新版本

参数:

当前版本号 - 服务器依靠版本号来判断当前请求的客户端版本和服务器上的众多版本之间的新旧关系。 当您在管理端发布新版本时，版本号一栏请务必填写和APP一样的版本号，且新的版本号必须比历史所有版本都大。 此参数建议和您项目的versionCode的值相同

回调 - 回调方法

读取公告

void 读取公告(API.读取公告回调 回调)

读取项目公告

参数:

回调 - 回调方法

setPinning

void setPinning(boolean pinning)

设置是否启用证书固定 启用证书固定之后，SDK会验证服务器的公钥证书是否可信，可有效防范中间人攻击。 请注意！服务器提供商可能在任何时候更换证书，证书更换之后APP将无法连接至服务器！ 更换证书将会提前在APP内通知开发者

参数:

pinning - 是否启用？

set证书链

void set证书链(ling.android.操作.okhttp.证书 证书链)

SDK内部已经设置号了服务器的公钥证书，如果服务器更换了公钥证书而没有即使提供新的SDK 那么您可以通过此方法来设置新的公钥证书。 证书链所有对象共享。

参数:

证书链 -

卡密登录

void 卡密登录(String 卡号,
 @NotNull
 API.卡密登录回调 回调)

使用卡密直接登录，要调用此API需要在圣使后端云客户端内启用项目的单码登录设置。 请注意，切换单码登录设置的值，将会导致您项目中的卡密数据定义模糊，污染卡密。 如果您必须切换登录模式，系统会代您删除所有脏污数据，无法撤销！

参数:

卡号 - 卡号

回调 - 回调

解绑卡密

void 解绑卡密(String 卡号,
 @NotNull
 API.解除绑定回调 回调)

解除一张卡密绑定的设备，要调用此API需要在圣使后端云客户端内启用项目的单码登录设置且启用设备绑定功能。 请注意，切换单码登录设置的值，将会导致您项目中的卡密数据定义模糊，污染卡密。 如果您必须切换登录模式，系统会代您删除所有脏污数据，无法撤销！

参数:

卡号 - 卡号

回调 - 回调

解绑账号

void 解绑账号(String user,
 String pass,
 @NotNull
 API.解除绑定回调 回调)

如果您的项目启用了绑定设备功能
那么您将会需要这个API
此API可以解除账号和设备的绑定
请注意！
解除绑定不会验证请求的设备是否是绑定的设备
既只要拥有账号和密码，且账号解绑间隔时间内没有解除过绑定，就可以请求解除绑定！

参数:

user - 用户账号

pass - 账号密码

回调 - 回调方法

setSign

void setSign(boolean Sign)

是否开启数字签名，启用此设置后，SDK会校验服务器响应数据的数字签名，用以保证数据安全

参数:

Sign - 是否启用数字签名

setServerPublicKey

void setServerPublicKey(String publicKey)
                 throws Exception

设置服务器的公钥，SDK中已经内置了公钥证书，一般情况下您无需改动。

参数:

publicKey - 公钥

抛出:

Exception - 公钥格式错误

get原始数据

String get原始数据()

读取服务器上一次响应的数据

返回:

上一次响应

修改密码

void 修改密码(账户数据类 user_data,
 String 原始密码,
 String 修改后的密码,
 @NotNull
 API.修改密码回调 回调)

修改账户的密码

参数:

user_data - 登录API返回的账户数据对象

原始密码 - 账号的原始密码

修改后的密码 - 修改后的密码