1. 描述
发起一次登录。登录包含如下几个接口,分别用于不同的环境下。
接口名称 | 登录的目标网站 | 描述 |
---|---|---|
AddLogin | 任何网站 | 通用调用方式 |
AddLoginx | console.xdua.com | 管理地球号所有资源。可以以任意方式登录。 |
AddLoginr | admin.app.com | 某个应用的管理平台,可以以任意方式登录。 |
AddToginx | console.xdua.com | 使用电话号码登录console.xdua.com |
AddMoginx | console.xdua.com | 使用邮箱地址登录console.xdua.com |
AddNoginx | console.xdua.com | 使用用户名登录console.xdua.com |
AddWoginx | console.xdua.com | 使用微信扫码登录console.xdua.com |
AddToginr | admin.app.com | 使用电话登录admin.app.com |
AddMoginr | admin.app.com | 使用邮箱登录admin.app.com |
AddNoginr | admin.app.com | 使用户名登录admin.app.com |
AddWoginr | admin.app.com | 使用微信扫码登录admin.app.com,登录方式为微信网页二维码扫描 |
AddAoginr | admin.app.com | 使用微信扫码登录admin.app.com,登录方式为微信小程序授权,没有超级管理后台 |
[!NOTE]
admin.app.com
表示地球号支持的社区级应用网站后台(例如admin.manhu.cn
就是慢护通养老管理平台。)。
2. 配置参数
参数意义参考接口参数
3. 请求参数
AddLogin
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 | |
---|---|---|---|---|---|---|---|
by | body | String | 是 | "tel"/"mail" | 必选 | ||
ustr | body | String | 是 | 电话格式是+86-15810419011/邮箱格式是:jiaoshuai@ict.ac.cn | 必选 | ||
pwd | body | String | 是 | 密码,32位md5码 | 必选 | ||
shop | body | String | 否 | 店铺 | 必选 | ||
role | body | String | 否 | 角色,默认"none" | 可选 | ||
afs | body | String | 是 | 人机验证码 | 必选 |
AddLoginx
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 | |
---|---|---|---|---|---|---|---|
by | body | String | 是 | "tel"/"mail" | 必选 | ||
ustr | body | String | 是 | 电话格式是+86-15810419011/邮箱格式是:jiaoshuai@ict.ac.cn | 必选 | ||
pwd | body | String | 是 | 密码,32位md5码 | 必选 | ||
afs | body | String | 是 | 人机验证码 | 必选 |
AddToginx
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 | |
---|---|---|---|---|---|---|---|
ustr | body | String | 是 | 电话格式是+86-15810419011/邮箱格式是:jiaoshuai@ict.ac.cn | 必选 | ||
pwd | body | String | 是 | 密码,32位md5码 | 必选 | ||
afs | body | String | 是 | 人机验证码 | 必选 |
AddMoginx
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 | |
---|---|---|---|---|---|---|---|
ustr | body | String | 是 | 邮箱格式是:jiaoshuai@ict.ac.cn | 必选 | ||
pwd | body | String | 是 | 密码,32位md5码 | 必选 | ||
afs | body | String | 是 | 人机验证码 | 必选 |
AddNoginx
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 | |
---|---|---|---|---|---|---|---|
ustr | body | String | 是 | 用户名字符串 | 必选 | ||
pwd | body | String | 是 | 密码,32位md5码 | 必选 | ||
afs | body | String | 是 | 人机验证码 | 必选 |
AddLoginr
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 | |
---|---|---|---|---|---|---|---|
by | body | String | 是 | "tel"/"mail" | 必选 | ||
ustr | body | String | 是 | 电话格式是+86-15810419011/邮箱格式是:jiaoshuai@ict.ac.cn | 必选 | ||
pwd | body | String | 是 | 密码,32位md5码 | 必选 | ||
role | body | String | 否 | 角色,默认"none" | 可选 | ||
afs | body | String | 是 | 人机验证码 | 必选 |
AddToginr
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 | |
---|---|---|---|---|---|---|---|
ustr | body | String | 是 | 电话格式是+86-15810419011/邮箱格式是:jiaoshuai@ict.ac.cn | 必选 | ||
pwd | body | String | 是 | 密码,32位md5码 | 必选 | ||
role | body | String | 否 | 角色,默认"none" | 可选 | ||
afs | body | String | 是 | 人机验证码 | 必选 |
AddMoginr
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 | |
---|---|---|---|---|---|---|---|
ustr | body | String | 是 | 邮箱格式是:jiaoshuai@ict.ac.cn | 必选 | ||
pwd | body | String | 是 | 密码,32位md5码 | 必选 | ||
role | body | String | 否 | 角色,默认"none" | 可选 | ||
afs | body | String | 是 | 人机验证码 | 必选 |
AddNoginr
名称 | 位置 | 类型 | 必填 | 默认值 | 示例 | 说明 | |
---|---|---|---|---|---|---|---|
ustr | body | String | 是 | 用户名字符串 | 必选 | ||
pwd | body | String | 是 | 密码,32位md5码 | 必选 | ||
role | body | String | 否 | 角色,默认"none" | 可选 | ||
afs | body | String | 是 | 人机验证码 | 必选 |
4. 返回参数
{
status: 200,
apid: 'F0B8FF02-B970-4DA3-9ED2-8543A84EB474',
apis: 'AddToginx',
error: 0,
reason: 'success',
message: 'Success.',
result: {
id: 'Dt5mvrtU',
token: 'eyJhbGciOiJSUzI1NiIsImtpZCI6ImI1MGIxZWZmZGMwMzVlMjg2OWI2YzQ1ZjMzYmRmNWQ3In0.eyJpYXQiOjE2MDY3MDI1NDksIm5iZiI6MTYwNjcwMjU0OSwiaXNzIjoieGR1YS5jb20iLCJleHAiOjE2MDY3MDMxNDksImF1ZCI6IkJyb3dTZGtUIiwic3ViIjoiRHQ1bXZydFUiLCJqdGkiOiIxMjM0NTY3OCIsInR5cCI6IlUiLCJ0YWciOiJQcmltYXJ5IiwiY2xyIjoiWCIsImlwbSI6IioiLCJkdm0iOiIqIiwib3duIjoiRHQ1bXZydFUiLCJzYXAiOiJTdktlcm5lTCIsImFwaSI6IkFkZExvZ2luIiwiem9uZSI6IlhkVWFYZHVBIiwiY29ycCI6IlhkVWFYZHVBIiwic2hvcCI6IlhkVWFYZHVBIiwicm9sZSI6IioiLCJydWxlIjoiKiIsImJ1ZyI6IkRFIiwidGlkIjoiUklHTktyUm4iLCJsZ24iOiJrZkFKOXZhaCJ9.k358orbypFBqJH4ieOJT9MBqTH5RtojCYvyps9gQEEZVmy2lCDRSLThRa99HhXvlTzujh7sjOwS-faw2JNOt8gFXkeQ5gbdBh1tScUKAMU3jzAC9QC2OdiOfjbS3Q7p86JhqdOWBSjsUroGeTF4X5mTKmJQuj4hobgCQKbzZ1lcgw3VpkjJP7gTUv7dAq14nk4pAm7fbSEJ1PGU_NKL2mZSoxLzsvi4xU-NvjDGE79twkiGd5QiNWzICZPa_Q67JnflOWVaOhm-7e40GDAFuZHYE4hp2jj3BKcVPK4ihn7lon2HRZ36IszloKuPjUW955TPKov4fQAbjexthSkSPXA'
},
}
名称 | 位置 | 类型 | 示例 | 说明 |
---|---|---|---|---|
id | result | string | rYub4wrT | 创建的用户ID |
token | String | 社登后的令牌,建议客户端在本地存储保存这个令牌,以便在接下来多次使用。 |
5. 错误码
6. SDK调用
const XduaClient = require('lovearth-xdua-browser-sdk')
const xduaClient = await XduaClient({
LOGIN_TOKEN:"eyJhbGciOi...",//开发者在地球号开发者网站创建的登录令牌
})
/**如果是电话号码登录**/
const api_param = {
ustr: '+86-15810419011',
pwd : 'a906449d5769fa7361d7ecc6aa3f6d28',
afs : '人机验证码',
}
/**如果是邮箱账号登录**/
const api_param = {
ustr: 'jiaoshuaihit@163.com',
pwd : 'a906449d5769fa7361d7ecc6aa3f6d28',
}
/**如果是名字账号登录**/
api_name = "微信用户名登录";
const api_param = {
ustr: '辣椒帅',
pwd : 'a906449d5769fa7361d7ecc6aa3f6d28',
}
/**微信网站扫码登录**/
api_name = "微信网站扫码登录";
const api_param = {
ustr: '001C5sHa1TDsVz0ie9Ha1VlwCv2C5sHE',
}
let res = await xduaClient.addWoginx(login_param)
/**在adminx.xdua.com上电话登录**/
let res = await xduaClient.addToginx(api_param)
/**在adminx.xdua.com上邮箱登录**/
let res = await xduaClient.addMoginx(api_param)
/**在adminx.xdua.com上户名登录**/
let res = await xduaClient.addNoginx(api_param)
/**在adminx.xdua.com上微信登录**/
let res = await xduaClient.addWoginx(api_param)
/**在应用级网站上电话登录**/
let res = await xduaClient.addToginr(api_param)
/**在应用级网站上邮箱登录**/
let res = await xduaClient.addMoginx(api_param)
/**在应用级网站上户名登录**/
let res = await xduaClient.addNoginx(api_param)
/**在应用级网站上微信登录**/
let res = await xduaClient.addWoginx(api_param)
console.log(res);
console.log(JSON.stringify(res));
if(res.error == 0){
console.log(api_name+"成功 ");
}else{
console.log(api_name+"失败 "+res.reason);
}
XduaClientHttpApi.getInstance().AddToginx( "+86-15810419011" , "a906449d5769fa7361d7ecc6aa3f6d28" , "afs_example" , new ApiCallback() {
@Override
public void onFailure(ApiRequest request, Exception e) {
e.printStackTrace();
}
@Override
public void onResponse(ApiRequest request, ApiResponse response) {
try {
System.out.println(getResultString(response));
}catch (Exception ex){
ex.printStackTrace();
}
}
});