藍鶯開發者
Web & Mini ProgramiOSAndroidC++Server API

2 token 介面#

2.1 通過使用者ID和密碼取普通使用者token#

POST /token/id

請求頭#

參數名稱資料類型必填描述
access-tokenstringfalseToken
app_idstringtrue應用程式ID
group_idint64false僅當access-token為管理員token時,可以設定此欄位,表示以此群ID的管理員身份來呼叫此介面
user_idint64false僅當access-token為管理員token時,可以設定此欄位,表示以此使用者ID的身份來呼叫此介面

請求體(Request Body)#

參數名稱資料類型必填預設值描述
device_guidstringfalse設備ID, 如果設定,則回傳PushToken
passwordstringtrue密碼
user_idint64true使用者ID,僅用於使用者ID登入

響應體#

● 200 響應資料格式:JSON

參數名稱類型描述
codeint32回傳碼,200是成功
dataobject結果資料
⇥ access_key_secretstring檔案密鑰
⇥ encrypt_typeint32是否啟用加密連接
⇥ expireint64過期時間戳
⇥ public_keystring公鑰
⇥ push_tokenstring推播Token
⇥ store_tokenstring檔案token
⇥ tokenstring訪問token, 即呼叫API時的access-token
⇥ user_idint64使用者ID
messagestring錯誤信息,如果成功,該項為null

介面描述#

2.2 通過使用者名/手機號/郵箱取普通使用者token#

POST /token/login

請求頭#

參數名稱資料類型必填描述
access-tokenstringfalseToken
app_idstringtrue應用程式ID
group_idint64false僅當access-token為管理員token時,可以設定此欄位,表示以此群ID的管理員身份來呼叫此介面
user_idint64false僅當access-token為管理員token時,可以設定此欄位,表示以此使用者ID的身份來呼叫此介面

請求體(Request Body)#

參數名稱資料類型必填預設值描述
device_guidstringfalse設備ID, 如果設定,則回傳PushToken
login_namestringtrue登入名,可以是手機號,郵箱,使用者名
passwordstringtrue密碼

響應體#

● 200 響應資料格式:JSON

參數名稱類型描述
codeint32回傳碼,200是成功
dataobject結果資料
⇥ access_key_secretstring檔案密鑰
⇥ encrypt_typeint32是否啟用加密連接
⇥ expireint64過期時間戳
⇥ public_keystring公鑰
⇥ push_tokenstring推播Token
⇥ store_tokenstring檔案token
⇥ tokenstring訪問token, 即呼叫API時的access-token
⇥ user_idint64使用者ID
messagestring錯誤信息,如果成功,該項為null

介面描述#

2.3 通過使用者名和密碼取普通使用者token#

POST /token/user

請求頭#

參數名稱資料類型必填描述
access-tokenstringfalseToken
app_idstringtrue應用程式ID
group_idint64false僅當access-token為管理員token時,可以設定此欄位,表示以此群ID的管理員身份來呼叫此介面
user_idint64false僅當access-token為管理員token時,可以設定此欄位,表示以此使用者ID的身份來呼叫此介面

請求體(Request Body)#

參數名稱資料類型必填預設值描述
device_guidstringfalse設備ID, 如果設定,則回傳PushToken
namestringtrue使用者名,僅用於使用者名登入
passwordstringtrue密碼

響應體#

● 200 響應資料格式:JSON

參數名稱類型描述
codeint32回傳碼,200是成功
dataobject結果資料
⇥ access_key_secretstring檔案密鑰
⇥ encrypt_typeint32是否啟用加密連接
⇥ expireint64過期時間戳
⇥ public_keystring公鑰
⇥ push_tokenstring推播Token
⇥ store_tokenstring檔案token
⇥ tokenstring訪問token, 即呼叫API時的access-token
⇥ user_idint64使用者ID
messagestring錯誤信息,如果成功,該項為null

介面描述#

自動產生的 API 內容,僅在必要位置補充精簡的 AI 解說。