Management Key

ดู API key รายการเดียว

ดึง API key หนึ่งรายการภายในขอบเขตที่ผู้เรียกมองเห็นได้ เมื่อใช้ Management Key ขององค์กร ID ต้องอยู่ในองค์กรของ key นั้นเอง ส่วน key ส่วนตัวของเจ้าของและ key จากองค์กรอื่นจะคืนค่า 404 เหมือนกันโดยไม่เปิดเผยว่ามีอยู่หรือไม่ รูปแบบการตอบกลับคือ { data: <key>, key: <key> } โดยทั้งสองฟิลด์มี object เดียวกัน <key> มี limit, limit_remaining, limit_reset, usage, usage_daily/weekly/monthly, requests, requests_daily/weekly/monthly และ usage_scope: key ตัวเลขการใช้งานตรงกับ GET /v1/key เมื่อเรียกด้วย key นั้น ค่า limit_remaining คือขีดจำกัดลบยอดใช้จ่ายของ key ในช่วงรีเซ็ต หรือเป็นยอดคงเหลือของบัญชีหรือองค์กรเมื่อไม่มีขีดจำกัดเฉพาะ key จะไม่คืนค่า secret แบบเต็ม

GET/v1/keys/:id

การอนุญาต

Authorizationจำเป็น

string · header

API key เป็น bearer token ใน header Authorization

พารามิเตอร์เส้นทาง

idจำเป็น

string

ID ของ API key ที่ต้องการดู

GET /v1/keys/:id

1
2
curl https://api.bazaarlink.ai/v1/keys/key_demo_01 \
  -H "Authorization: Bearer $BAZAARLINK_MANAGEMENT_KEY"

ตัวอย่างการตอบกลับ

สำเร็จ data และ key มี object key เดียวกัน และ usage_scope จะเป็น key เสมอ

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
  "data": {
    "id": "key_demo_01",
    "name": "worker-a",
    "keyPrefix": "demo_",
    "keySuffix": "01",
    "enabled": true,
    "keyType": "standard",
    "limit": 10,
    "limit_remaining": 7.88,
    "limit_reset": "day",
    "usage": 24.41,
    "usage_daily": 2.12,
    "usage_weekly": 5.64,
    "usage_monthly": 9.37,
    "requests": 314,
    "requests_daily": 18,
    "requests_weekly": 61,
    "requests_monthly": 205,
    "usage_scope": "key",
    "spendLimitUsd": 10,
    "spendLimitPeriod": "day",
    "organizationId": "org_demo_01",
    "expiresAt": null
  },
  "key": {
    "id": "key_demo_01",
    "name": "worker-a",
    "keyPrefix": "demo_",
    "keySuffix": "01",
    "enabled": true,
    "keyType": "standard",
    "limit": 10,
    "limit_remaining": 7.88,
    "limit_reset": "day",
    "usage": 24.41,
    "usage_daily": 2.12,
    "usage_weekly": 5.64,
    "usage_monthly": 9.37,
    "requests": 314,
    "requests_daily": 18,
    "requests_weekly": 61,
    "requests_monthly": 205,
    "usage_scope": "key",
    "spendLimitUsd": 10,
    "spendLimitPeriod": "day",
    "organizationId": "org_demo_01",
    "expiresAt": null
  }
}