UC接口文档
一、功能描述
提供同步登录、退出、注册等相关接口,可以实现用户一个账号,在一处登录,全站通行。
二、测试环境UC地址
三、相关接口
UC_API=http://s1.p5w.net/uc/
UC_IP =
UC_KEY = 123456
UC_APPID = 15
UC_CONNECT =
1.注册
integer uc_user_register(string username , string password , string email)
参数说明
username |
用户名 |
password |
密码 |
|
电子邮件地址 |
返回值
值 integer |
大于 0:返回用户 ID,表示用户注册成功 |
2.用户登录
array uc_user_login(string username , string password [, bool isuid])
参数说明
username |
用户名 |
|
password |
密码 |
|
isuid |
是否使用用户 ID登录 |
1:使用用户 ID登录 |
返回值
值 String |
大于 0:返回用户 ID,表示用户登录成功 |
3.获取用户数据
array uc_get_user(string username [, bool isuid])
参数说明
username |
用户名 |
|
isuid |
是否使用用户 ID登录 |
1:使用用户 ID登录 |
返回值
值 array integer [0] string [1] string [2]
integer [0] |
用户 ID |
string [1] |
用户名 |
string [2] |
|
4.更新用户资料
integer uc_user_edit(string username , string oldpw , string newpw , string email [, boolignoreoldpw])
参数说明
username |
用户名 |
|
oldpw |
旧密码 |
|
newpw |
新密码 |
|
|
邮箱地址 |
|
ignoreoldpw |
是否忽略旧密码 |
1:忽略,更改资料不需要验证密码 |
返回值
值 integer |
1:更新成功 |
5.删除用户
integer uc_user_delete(string/array username)
参数说明
username |
用户名 |
返回值
值 integer |
1:成功 0:失败 |
6.同步登录
string uc_user_synlogin(integer uid)
参数说明
uid |
用户ID |
返回值
值 string |
同步登录的 HTML 代码 |
7.同步退出
string uc_user_synlogout()
参数说明
uid |
用户ID |
返回值
值 string |
同步退出的 HTML 代码 |
8.检查 Email 地址
integer uc_user_checkemail(string email)
参数说明
|
用户ID |
返回值
值 integer |
1:成功 |
9.检查用户名
integer uc_user_checkname(string username)
参数说明
username |
用户名 |
返回值
值 integer |
1:成功 |
四、接收消息通知
接收通知的请求URL /api/uc.php
例:
http://s2.p5w.net/api/uc.php?time=1566975513&code=504ca0TEJqqu%2Bh%2BkdPBM0ryA9NP9bqKiUsR5V%2FK2k0LsFybIPXQAvjtWlevmxOmRm8dORwC2PdI%2F1QjtkL9YjoUZxGZwj0Euch6PyTnVbM9FOAsz2CIOHchQReL7yc%2F2XIX%2BRwPaUvvW8j88bA%2BVcCWJHyDdgVdP3s7PML9JK9cyYmenZg&_=1566975497211
1、test
此接口供仅测试连接。当 UCenter 发起 test 的接口请求时,如果成功获取到接口返回的 API_RETURN_SUCCEED 值,表示 UCenter 和应用通讯正常。
2、deleteuser
当 UCenter 删除一个用户时,会发起 deleteuser 的接口请求,通知所有应用程序删除相应的用户。
输入的参数放在 $get['ids'] 中,值为用逗号分隔的用户 ID。如果删除成功则输出 API_RETURN_SUCCEED。
3、renameuser
当 UCenter 更改一个用户的用户名时,会发起 renameuser 的接口请求,通知所有应用程序改名。
输入的参数 $get['uid'] 表示用户 ID,$get['oldusername'] 表示旧用户名,$get['newusername'] 表示新用户名。如果修改成功则输出 API_RETURN_SUCCEED。
4、updatepw
当用户更改用户密码时,此接口负责接受 UCenter 发来的新密码。
输入的参数 $get['username'] 表示用户名,$get['password'] 表示新密码。如果修改成功则输出 API_RETURN_SUCCEED。
5、gettag
如果应用程序存在标签功能,可以通过此接口把应用程序的标签数据传递给 UCenter。
输入的参数放在 $get['id'] 中,值为标签名称。输出的数组需经过 uc_serialize 处理。
integer [0] 标签名称
array [1] 标签数据 mixed ['xxx'] 自定义
自定义多个数组项,索引名任意,一同返回给 UCenter。为了保证应用间数据的共享,您需要在“应用管理管理”的“标签单条显示模板”和“标签模板标记说明”设置模板和说明。模板中 “{xxx}”表示标签数据的索引,代表相应的数据。如扩展数据模板中的“{image}”将显示“['image']”数组项的内容。
6、synlogin
如果应用程序需要和其他应用程序进行同步登录,此部分代码负责标记指定用户的登录状态。
输入的参数放在 $get['uid'] 中,值为用户 ID。此接口为通知接口,无输出内容。同步登录需使用 P3P 标准。
7、synlogout
如果应用程序需要和其他应用程序进行同步退出登录,此部分代码负责撤销用户的登录的状态。
此接口为通知接口,无输入参数和输出内容。同步退出需使用 P3P 标准。
8、updatebadwords
当 UCenter 的词语过滤设置变更时,此接口负责通知所有应用程序更新后的词语过滤设置内容。
设置内容用 POST 方式提交到接口。接口运行完毕输出 API_RETURN_SUCCEED。
9、updatehosts
当 UCenter 的域名解析设置变更时,此接口负责通知所有应用程序更新后的域名解析设置内容。
设置内容用 POST 方式提交到接口。接口运行完毕输出 API_RETURN_SUCCEED。
10、updateapps
当 UCenter 的应用程序列表变更时,此接口负责通知所有应用程序更新后的应用程序列表。
设置内容用 POST 方式提交到接口。接口运行完毕输出 API_RETURN_SUCCEED。
11、updateclient
当 UCenter 的基本设置信息变更时,此接口负责通知所有应用程序更新后的基本设置内容。
设置内容用 POST 方式提交到接口。接口运行完毕输出 API_RETURN_SUCCEED。
12、updatecredit
当某应用执行了积分兑换请求的接口函数 uc_credit_exchange_request() 后,此接口负责通知被兑换的目的应用程序所需修改的用户积分值。
输入的参数 $get['credit'] 表示积分编号,$get['amount'] 表示积分的增减值,$get['uid'] 表示用户 ID。
13、getcreditsettings
此接口负责把应用程序的积分设置传递给 UCenter,以供 UCenter 在积分兑换设置中使用。
此接口无输入参数。输出的数组需经过 uc_serialize 处理。
输出的数组单条结构: 1 维 KEY 2 维 KEY
array [n] 积分编号 string [0] 积分名称
string [1] 积分单位
如:
array(
'1' => array('威望', ''),
'2' => array('金钱', '枚'),
)
14、updatecreditsettings
此接口负责接收 UCenter 积分兑换设置的参数。
输入的参数放在 $get['credit'] 中,值为设置的参数数组。接口运行完毕输出 API_RETURN_SUCCEED。
输入的数组单条结构: 1 维 KEY 2 维 KEY
array [appid] 应用程序 ID integer ['appiddesc'] 积分兑换的目标应用程序 ID
integer ['creditdesc'] 积分兑换的目标积分编号
integer ['creditsrc'] 积分兑换的源积分编号
string ['title'] 积分名称
string ['unit'] 积分单位
integer ['ratio'] 积分兑换比率
如:
array(
'1' => array(
'appiddesc' => 2,
'creditdesc' => 1,
'creditsrc' => 1,
'title' => '金钱',
'unit' => '枚',
'ratio' => 2,
),
)
15、getcredit
此接口用于把应用程序中指定用户的积分传递给 UCenter。
输入的参数 $get['uid'] 为用户 ID,$get['credit'] 为积分编号。接口运行完毕输出积分值。
来源:https://www.cnblogs.com/yipianchuyun/p/12286912.html