認證與簽署

API Key 管理

以 Markdown 格式查看

API Key 管理端點只接受 JWT 認證。

創造 API Key

1POST /v1/private/user/api-key/create
2Authorization: Bearer YOUR_ACCESS_TOKEN
3Content-Type: application/json

請求參數：

參數類型必修描述
labelstring是的API Key 標籤，長度1至64
permissions智力不權限位元掩蓋、預設 1、範圍 1 - 7
ipWhitelist弦[]不IP 白名單，最多可錄20個條目。若省略，來源 IP 為無限制

請求範例：

$curl -X POST https://api.6mm.com/v1/private/user/api-key/create \
>  -H "Content-Type: application/json" \
>  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
>  -d '{
>    "label": "external-service-prod",
>    "permissions": 3,
>    "ipWhitelist": ["203.0.113.10"]
>  }'

回應範例：

1{
2  "code": 0,
3  "message": "success",
4  "data": {
5    "apiKey": "fx_xxxxxxxxxxxxxxxxxxxxxxxx",
6    "apiSecret": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
7  },
8  "requestId": "req-api-key"
9}

apiSecret 在 API Key 建立時只會回傳一次。立即將它儲存在秘密管理系統中。不要把它寫進原始碼庫或日誌。

每位使用者最多可建立 30 把 API 鑰匙。

API 鑰匙列表

1GET /v1/private/user/api-key/list
2Authorization: Bearer YOUR_ACCESS_TOKEN

回應欄位：

場地類型描述
list[].idstringAPI Key ID
list[].labelstring唱片公司
list[].apiKeystring公開 API Key 識別碼
list[].permissions智力權限位元掩模
list[].ipWhitelist弦[]IP 白名單
list[].status智力狀態： 1 啟用， 0 停用
list[].lastUsedAtint64最後使用時間
list[].createdAtint64創作時間

更新 API Key

1PUT /v1/private/user/api-key/update
2Authorization: Bearer YOUR_ACCESS_TOKEN
3Content-Type: application/json

請求參數：

參數類型必修描述
idstring是的API Key ID
labelstring不新唱片公司
permissions智力不新權限位元遮罩
ipWhitelist弦[]不新 IP 白名單
status智力不1 啟用， 0 停用

刪除 API Key

1POST /v1/private/user/api-key/delete
2Authorization: Bearer YOUR_ACCESS_TOKEN
3Content-Type: application/json

請求正文：

1{ "id": "1001" }

刪除所有 API 鍵

1POST /v1/private/user/api-key/delete-all
2Authorization: Bearer YOUR_ACCESS_TOKEN
3Content-Type: application/json

回應欄位：

場地類型描述
deletedint64刪除 API 鑰匙數量