找回密码
 免费注册

UCenter 的接口函数

[复制链接]
admin 发表于 2020-11-27 15:47:58 | 显示全部楼层 |阅读模式
UCenter 分为 MySQL 和远程两种接口连接方式,MySQL 方式是直接连接数据库因此速度较快,但当 UCenter 的服务端和客户端不在同一主机中且没有远程 MySQL 帐号的情况下,则只能使用远程连接方式。使用 UCenter 接口函数前请根据应用程序的需求定义以下相关常量:
    UC_CONNECT  连接 UCenter 的方式 mysql:MySQL 方式 空:远程方式
    UC_DBHOST  UCenter 数据库主机
    UC_DBUSER  UCenter 数据库用户名
    UC_DBPW  UCenter 数据库密码
    UC_DBNAME  UCenter 数据库名称
    UC_DBCHARSET  UCenter 数据库字符集
    UC_DBTABLEPRE  UCenter 数据库表前缀
    UC_DBCONNECT  UCenter 数据库持久连接 0=关闭, 1=打开
    UC_KEY  与 UCenter 的通信密钥, 要与 UCenter 保持一致
    UC_API  UCenter 服务端的 URL 地址
    UC_IP  UCenter 的 IP, 当 UC_CONNECT 为非 mysql 方式时, 并且当前应用服务器解析域名有问题时, 请设置此值
    UC_CHARSET  UCenter 的字符集
    UC_APPID  当前应用的 ID

使用 UCenter 接口函数库必须包含 uc_client/client.php 接口函数库文件

用户接口
此部分接口负责用户的注册、登录,可实现用户表的统一管理。
uc_user_register
用于新用户的注册
uc_user_login
用于用户的登录验证
uc_get_user
用于获取用户在 UCenter 的基本数据
uc_user_edit
用于更新用户资料
uc_user_delete
用于删除用户
uc_user_deleteavatar
用于删除用户头像
uc_user_synlogin
用于用户同步登录
uc_user_synlogout
用于用户同步退出
uc_user_checkemail
用于检查用户输入的 Email 的合法性
uc_user_checkname
用于检查用户输入的用户名的合法性
uc_user_addprotected
用于添加被保护的用户
uc_user_deleteprotected
用于删除被保护的用户
uc_user_getprotected
用于获得被保护的用户列表
uc_user_merge
用于把重名的用户合并到 UCenter
uc_user_merge_remove
用于移除重名用户记录中的指定记录
uc_user_getcredit
用于获取指定应用的指定用户积分

短消息接口
此部分接口负责用户间的短消息传输,可以跨应用间互相发送短消息。“短消息中心”的界面接口可以让应用只需一个函数接口即拥有短消息功能,对于高级用户 UCenter 也提供了丰富的收发接口函数供用户自己开发短消息系统。
uc_pm_location
本接口函数运行后会发送一个 header 的 location 请求,使当前页面跳转到短消息中心。
uc_pm_checknew
本接口函数会检查指定用户是否有新的短消息。
uc_pm_send
本接口函数用于发送短消息。
uc_pm_delete
本接口函数将删除指定文件夹中的指定消息 ID 的短消息。
uc_pm_deleteuser
本接口函数将删除和 uid 对话的 touids 中的所有短消息。
uc_pm_deletechat
本接口函数用于群聊短消息的退出和删除。
uc_pm_readstatus
本接口函数用于标记短消息的已读/未读状态。
uc_pm_list
本接口函数用于获取指定文件夹的短消息列表。
uc_pm_ignore
本接口函数用于直接忽略未读短消息的提示状态。
uc_pm_view
本接口函数用于返回指定用户的指定消息 ID 的消息。
uc_pm_view_num
本接口函数用于返回指定会话的消息数量。
uc_pm_viewnode
本接口函数用于查询单条短消息内容。
uc_pm_chatpmmemberlist
本接口函数用于返回群聊成员列表。
uc_pm_kickchatpm
本接口函数用于将指定用户踢出群聊会话。
uc_pm_appendchatpm
本接口函数用于添加群聊成员。
uc_pm_blackls_get
本接口函数返回用户的黑名单设置的内容。
uc_pm_blackls_set
本接口函数用于更新用户的黑名单列表数据。
uc_pm_blackls_add
本接口函数用于添加用户的黑名单项目。
uc_pm_blackls_delete
本接口函数用于删除用户的黑名单项目。

好友接口
此部分接口负责用户好友信息的共享。一个应用更新的好友资料其他应用都能够看到。
uc_friend_add
本函数接口用于把 friendid 添加为 uid 的好友。
uc_friend_delete
本函数接口用于删除指定用户的好友。
uc_friend_totalnum
本接口函数用于返回指定用户的好友数。
uc_friend_ls
本接口函数用于返回好友列表数据。

积分接口
此部分接口负责应用间的积分兑换。
uc_credit_exchange_request
本接口函数用于积分兑换处理。

头像接口
此部分接口提供了一套用户头像的编辑、显示的平台,可以让应用拥有用头像的编辑功能。
uc_avatar
本接口函数用于返回设置用户头像的 HTML 代码。
uc_check_avatar
本接口函数用于检测指定用户的头像是否存在。

标签接口
此部分接口负责应用间标签信息的聚合。
uc_tag_get
本接口会向用户中心发起一个请求,要求获取用户中心中所有应用的标签数据。

事件接口
此部分接口负责应用间信息的聚合。
uc_feed_add
本接口函数用于向 UCenter Home 添加事件。如果正确则返回事件的 ID。
uc_feed_get
本接口函数用于提取事件。如果正确则返回事件列表数组。

应用接口
此部分接口用于获取应用相关信息。
uc_app_ls
本接口获取 UCenter 中所有应用的列表数据。

邮件接口
此部分接口用来将邮件加入到邮件队列,或者直接发送邮件(当level为0时)。
uc_mail_queue
本函数用来将邮件加入到邮件队列,或者直接发送邮件(当level为0时)。


回复

使用道具 举报

 楼主| admin 发表于 2020-11-27 16:20:10 | 显示全部楼层
通知接口相关http://www.mamicode.com/info-detail-2922230.html
https://www.cnblogs.com/yipianchuyun/p/12286912.html

一、功能描述
提供同步登录、退出、注册等相关接口,可以实现用户一个账号,在一处登录,全站通行。

二、测试环境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
密码
email
电子邮件地址

返回值
值 integer
大于 0:返回用户 ID,表示用户注册成功
-1:用户名不合法
-2:包含不允许注册的词语
-3:用户名已经存在
-4:Email 格式有误
-5:Email 不允许注册
-6:该 Email 已经被注册
2.用户登录
array uc_user_login(string username , string password [, bool isuid])

参数说明
username
用户名

password
密码

isuid
是否使用用户 ID登录
1:使用用户 ID登录
0:(默认值) 使用用户名登录

返回值
值 String
大于 0:返回用户 ID,表示用户登录成功
-1:用户不存在,或者被删除
-2:密码错
3.获取用户数据
array uc_get_user(string username [, bool isuid])

参数说明
username
用户名

isuid
是否使用用户 ID登录
1:使用用户 ID登录
0:(默认值) 使用用户名登录

返回值
值 array integer [0] string [1] string [2]
integer [0]
用户 ID
string [1]
用户名
string [2]
Email

4.更新用户资料
integer uc_user_edit(string username , string oldpw , string newpw , string email [, boolignoreoldpw])

参数说明
username
用户名

oldpw
旧密码

newpw
新密码

email
邮箱地址

ignoreoldpw
是否忽略旧密码
1:忽略,更改资料不需要验证密码
0:(默认值) 不忽略,更改资料需要验证密码

返回值
值 integer
1:更新成功
0:没有做任何修改
-1:旧密码不正确
-4:Email 格式有误
-5:Email 不允许注册
-6:该 Email 已经被注册
-7:没有做任何修改
-8:该用户受保护无权限更改
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)

参数说明
email
用户ID

返回值
值 integer
1:成功
-4:Email 格式有误
-5:Email 不允许注册
-6:该 Email 已经被注册
9.检查用户名
integer uc_user_checkname(string username)

参数说明
username
用户名

返回值
值 integer
1:成功
-1:用户名不合法
-2:包含要允许注册的词语
-3:用户名已经存在

四、接收消息通知
接收通知的请求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'] 为积分编号。接口运行完毕输出积分值。


回复

使用道具 举报

您需要登录后才可以回帖 登录 | 免费注册

本版积分规则

QQ|Archiver|手机版|小黑屋|信息共享网

GMT+8, 2024-5-15 03:53 , Processed in 0.080637 second(s), 22 queries .

Powered by Discuz! X3.5

© 2001-2024 Discuz! Team.

快速回复 返回顶部 返回列表