一、接口總覽
| 接口名稱 | 功能描述 | 請(qǐng)求方式 | 授權(quán)方式 | 接口版本 |
|---|---|---|---|---|
| 查詢賬戶信息(get_account) | 查詢VSaaS賬戶的詳細(xì)信息,支持按需返回指定字段 | GET / POST (GraphQL) | JWT / Bearer Token 授權(quán) | v1 |
| 修改賬戶信息(update_account) | 更新VSaaS賬戶的基本信息(昵稱、姓名、語言等) | GET / POST (GraphQL) | JWT / Bearer Token 授權(quán) | v1 |
| 刪除賬戶(delete_account) | 刪除VSaaS賬戶,解綁關(guān)聯(lián)設(shè)備/方案(不可恢復(fù)) | DELETE (RESTful) | JWT / Bearer Token 授權(quán) | v1 |
本章節(jié)介紹VSaaS平臺(tái)賬戶管理核心API接口(GraphQL/RESTful版本),第三方系統(tǒng)可通過這些接口完成賬戶信息的管理操作,所有接口均需攜帶有效的VSaaS Token完成身份認(rèn)證。
二、賬戶管理API
(一)查詢賬戶信息(get_account)
通過GraphQL查詢VSaaS賬戶的詳細(xì)信息,支持按需返回指定字段,返回賬戶的基礎(chǔ)信息及擴(kuò)展屬性。
1. 請(qǐng)求說明
1.1 請(qǐng)求URL
GET: https://vsaas.kalay.us/vsaas/api/v1/be?query={get_account [VsaasAccount]}
POST: https://vsaas.kalay.us/vsaas/api/v1/be/
說明:支持GET/POST方式,推薦使用POST方式通過請(qǐng)求體傳遞復(fù)雜查詢
1.2 請(qǐng)求頭(Header)
| 參數(shù)名 | 類型 | 必選 | 說明 |
|---|---|---|---|
Authorization | String | 是 | 授權(quán)令牌,格式:JWT {token} 或 Bearer {token} |
Content-Type | String | 是 | 固定值:application/json |
1.3 請(qǐng)求參數(shù)
| 參數(shù)名 | 類型 | 必選 | 位置 | 說明 |
|---|---|---|---|---|
| 無 | - | - | - | 查詢參數(shù)通過GraphQL語法在query中指定返回字段 |
1.4 請(qǐng)求體(POST 方式專用)
{
"query": "query {get_account {pk,email,nickname,lang,uid,created}}"
}
(二)響應(yīng)說明
1. 響應(yīng)狀態(tài)碼
| 狀態(tài)碼 | 徽章 | 說明 |
|---|---|---|
| 200 | 成功 | 請(qǐng)求成功,返回賬戶信息 |
| 400 | 參數(shù)錯(cuò)誤 | GraphQL語法錯(cuò)誤、參數(shù)格式錯(cuò)誤等 |
| 401 | 認(rèn)證失敗 | Token無效或過期 |
2. 響應(yīng)數(shù)據(jù)結(jié)構(gòu)
{
"data": {
"get_account": {
"pk": "String", // 賬戶主鍵ID
"vendor": "String", // 廠商標(biāo)識(shí)
"lang": "String", // 賬戶語言設(shè)置
"nickname": "String", // 賬戶昵稱
"email": "String", // 賬戶郵箱
"phone": "String", // 賬戶手機(jī)號(hào)
"userId": "String", // 用戶ID
"name": "String", // 賬戶姓名
"uid": "String", // 賬戶唯一標(biāo)識(shí)
"created": "String", // 賬戶創(chuàng)建時(shí)間
"updated": "String", // 賬戶更新時(shí)間
"last_login": "String", // 最后登錄時(shí)間
"is_active": "Boolean" // 賬戶是否激活
}
}
}
3. 響應(yīng)參數(shù)說明
| 字段名 | 類型 | 說明 | 返回規(guī)則 |
|---|---|---|---|
pk | String | 賬戶主鍵ID | 可選返回(需在查詢中指定) |
vendor | String | 廠商標(biāo)識(shí) | 可選返回(需在查詢中指定) |
lang | String | 賬戶語言設(shè)置 | 可選返回(需在查詢中指定) |
nickname | String | 賬戶昵稱 | 可選返回(需在查詢中指定) |
email | String | 賬戶郵箱 | 可選返回(需在查詢中指定) |
phone | String | 賬戶手機(jī)號(hào) | 可選返回(需在查詢中指定) |
userId | String | 用戶ID | 可選返回(需在查詢中指定) |
name | String | 賬戶姓名 | 可選返回(需在查詢中指定) |
uid | String | 賬戶唯一標(biāo)識(shí) | 可選返回(需在查詢中指定) |
created | String | 賬戶創(chuàng)建時(shí)間 | 可選返回(需在查詢中指定) |
updated | String | 賬戶更新時(shí)間 | 可選返回(需在查詢中指定) |
last_login | String | 最后登錄時(shí)間 | 可選返回(需在查詢中指定) |
is_active | Boolean | 賬戶是否激活 | 可選返回(需在查詢中指定) |
(三)接口示例
1. 請(qǐng)求示例(curl)
POST方式請(qǐng)求(示例)
curl --location --request POST 'https://vsaas.kalay.us/vsaas/api/v1/be/' \
--header 'Authorization: Bearer LKdkjlk8873BNN' \
--header 'Content-Type: application/json' \
--data-raw '{
"query": "query {get_account {pk,email,nickname,lang}}"
}'
GET方式請(qǐng)求(示例)
curl --location --request GET 'https://vsaas.kalay.us/vsaas/api/v1/be?query={get_account {pk,email,nickname,lang}}' \
--header 'Authorization: Bearer LKdkjlk8873BNN' \
--header 'Content-Type: application/json'
2. 響應(yīng)示例(成功)
賬戶信息響應(yīng)(示例)
{
"data": {
"get_account": {
"email": "",
"lang": "zh-CN",
"nickname": "test_user",
"pk": "8f7e6d5c4b3a2e1f0e9d8c7b6a5f4e3d"
}
}
}
(二)修改賬戶信息(update_account)
通過GraphQL的mutation更新VSaaS賬戶的基本信息,支持修改昵稱、姓名、語言設(shè)置等字段,僅需傳入需要修改的參數(shù)。
1. 請(qǐng)求說明
1.1 請(qǐng)求URL
GET: https://vsaas.kalay.us/vsaas/api/v1/be?query=mutation {update_account(nickname:string,name:string,lang:string)}
POST: https://vsaas.kalay.us/vsaas/api/v1/be/
1.2 請(qǐng)求頭(Header)
| 參數(shù)名 | 類型 | 必選 | 說明 |
|---|---|---|---|
Authorization | String | 是 | 授權(quán)令牌,格式:JWT {token} 或 Bearer {token} |
Content-Type | String | 是 | 固定值:application/json |
1.3 請(qǐng)求參數(shù)
| 參數(shù)名 | 類型 | 必選 | 位置 | 說明 |
|---|---|---|---|---|
nickname | String | 否 | GraphQL參數(shù) MUTATION | 新的賬戶昵稱 |
name | String | 否 | GraphQL參數(shù) MUTATION | 新的賬戶姓名 |
lang | String | 否 | GraphQL參數(shù) MUTATION | 新的語言設(shè)置(如zh-CN/en-US) |
1.4 請(qǐng)求體(POST 方式專用)
{
"query": "mutation {update_account(nickname:\"jj\",name:\"jyp\")}"
}
(二)響應(yīng)說明
1. 響應(yīng)狀態(tài)碼
| 狀態(tài)碼 | 徽章 | 說明 |
|---|---|---|
| 200 | 成功 | 請(qǐng)求成功,賬戶信息已更新 |
| 400 | 參數(shù)錯(cuò)誤 | GraphQL語法錯(cuò)誤、參數(shù)格式錯(cuò)誤等 |
| 401 | 認(rèn)證失敗 | Token無效或過期 |
2. 響應(yīng)數(shù)據(jù)結(jié)構(gòu)
{
"data": {
"update_account": "success"
}
}
3. 響應(yīng)參數(shù)說明
| 字段名 | 類型 | 說明 | 返回規(guī)則 |
|---|---|---|---|
data | Object | 響應(yīng)數(shù)據(jù)對(duì)象,包含更新結(jié)果 | 必返回(無需額外指定) |
update_account | String | 更新結(jié)果標(biāo)識(shí)(success/fail) | 必返回(無需額外指定) |
(三)接口示例
1. 請(qǐng)求示例(curl)
POST方式請(qǐng)求(示例)
curl --location --request POST 'https://vsaas.kalay.us/vsaas/api/v1/be/' \
--header 'Authorization: Bearer LKdkjlk8873BNN' \
--header 'Content-Type: application/json' \
--data-raw '{
"query": "mutation {update_account(nickname:\"jj\",name:\"jyp\")}"
}'
GET方式請(qǐng)求(示例)
curl --location --request GET 'https://vsaas.kalay.us/vsaas/api/v1/be?query=mutation {update_account(nickname:\"jj\",name:\"jyp\")}' \
--header 'Authorization: Bearer LKdkjlk8873BNN' \
--header 'Content-Type: application/json'
2. 響應(yīng)示例(成功)
賬戶更新響應(yīng)(示例)
{
"data": {
"update_account": "success"
}
}
(三)刪除賬戶(delete_account)
通過RESTful API刪除VSaaS賬戶,刪除后賬戶關(guān)聯(lián)的設(shè)備、方案等信息將被解綁(但不會(huì)刪除),賬戶數(shù)據(jù)不可恢復(fù),操作前需確保賬戶無未處理的業(yè)務(wù)關(guān)聯(lián)。
1. 請(qǐng)求說明
1.1 請(qǐng)求URL
DELETE: https://vsaas.kalay.us/vsaas/api/v1/be/account
說明:僅支持DELETE方式,賬戶標(biāo)識(shí)通過Token上下文關(guān)聯(lián)
1.2 請(qǐng)求頭(Header)
| 參數(shù)名 | 類型 | 必選 | 說明 |
|---|---|---|---|
Authorization | String | 是 | 授權(quán)令牌,格式:JWT {token} 或 Bearer {token} |
Content-Type | String | 是 | 固定值:application/json |
1.3 請(qǐng)求參數(shù)
| 參數(shù)名 | 類型 | 必選 | 位置 | 說明 |
|---|---|---|---|---|
| 無 | - | - | - | 賬戶標(biāo)識(shí)通過上下文/Token關(guān)聯(lián) |
(二)響應(yīng)說明
1. 響應(yīng)狀態(tài)碼
| 狀態(tài)碼 | 徽章 | 說明 |
|---|---|---|
| 200 | 成功 | 請(qǐng)求成功,賬戶已刪除 |
| 400 | 參數(shù)錯(cuò)誤 | 請(qǐng)求參數(shù)格式錯(cuò)誤 |
| 401 | 認(rèn)證失敗 | Token無效或過期 |
| 409 | 沖突 | 賬戶關(guān)聯(lián)的設(shè)備未解綁,無法刪除 |
2. 響應(yīng)數(shù)據(jù)結(jié)構(gòu)
{
"data": {
"delete_account": "success",
"delete_time": "String" // 刪除時(shí)間
}
}
3. 響應(yīng)參數(shù)說明
| 字段名 | 類型 | 說明 | 返回規(guī)則 |
|---|---|---|---|
data | Object | 響應(yīng)數(shù)據(jù)對(duì)象,包含刪除結(jié)果 | 必返回(無需額外指定) |
delete_account | String | 刪除結(jié)果標(biāo)識(shí)(success/fail) | 必返回(無需額外指定) |
delete_time | String | 賬戶刪除時(shí)間(格式:YYYY-MM-DD HH:MM:SS) | 必返回(無需額外指定) |
(三)接口示例
1. 請(qǐng)求示例(curl)
DELETE方式請(qǐng)求(示例)
curl --location --request DELETE 'https://vsaas.kalay.us/vsaas/api/v1/be/account' \
--header 'Authorization: Bearer LKdkjlk8873BNN' \
--header 'Content-Type: application/json'
2. 響應(yīng)示例(成功)
賬戶刪除響應(yīng)(示例)
{
"data": {
"delete_account": "success",
"delete_time": "2025-01-01 15:00:00"
}
}
