Quản lý API Key

API Key đầu cuối quản lý chỉ chấp nhận xác thực JWT .

Tạo API Key

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

Tham số yêu cầu:

Tham số	Loại	Bắt buộc	Mô tả
`label`	string	Đúng vậy	API Key nhãn, độ dài 1 - 64
`permissions`	int	Không	Bitmask quyền, `1`mặc định, phạm vi `1` - `7`
`ipWhitelist`	string[]	Không	IP danh sách trắng, tối đa 20 mục. Nếu bỏ qua, IP nguồn không bị giới hạn

Yêu cầu ví dụ:

$ 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"]
>   }'

Ví dụ phản hồi:

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

apiSecret chỉ được trả về một lần khi API Key được tạo. Lưu nó ngay lập tức trong hệ thống quản lý bí mật. Không ghi nó vào kho mã nguồn hoặc nhật ký.

Mỗi người dùng có thể tạo tối đa 30 Khóa API .

Danh sách API khóa

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

Trường phản hồi:

Lĩnh vực	Loại	Mô tả
`list[].id`	string	ID API Key
`list[].label`	string	Nhãn hiệu
`list[].apiKey`	string	Định danh API Key công khai
`list[].permissions`	int	Bitmask quyền
`list[].ipWhitelist`	string[]	IP danh sách trắng
`list[].status`	int	Trạng thái: `1` bật, `0` vô hiệu hóa
`list[].lastUsedAt`	int64	Thời gian sử dụng cuối cùng
`list[].createdAt`	int64	Thời gian sáng tạo

Cập nhật API Key

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

Tham số yêu cầu:

Tham số	Loại	Bắt buộc	Mô tả
`id`	string	Đúng vậy	ID API Key
`label`	string	Không	Nhãn hiệu mới
`permissions`	int	Không	Bitmask quyền mới
`ipWhitelist`	string[]	Không	Danh sách trắng IP mới
`status`	int	Không	`1` bật, `0` vô hiệu hóa

Xóa API Key

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

Nội dung yêu cầu:

1 { "id": "1001" }

Xóa Tất Cả Khóa API

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