UC接口文檔

一、功能描述

提供同步登錄、退出、注冊等相關接口，可以實現用戶一個賬號，在一處登錄，全站通行。

二、測試環境UC地址

http://s1.p5w.net/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'] 為積分編號。接口運行完畢輸出積分值。