Management Key

एक API कुंजी पाएं

कॉल करने वाले के दृश्य दायरे में एक API कुंजी प्राप्त करता है। संगठन की Management Key के साथ ID उसी कुंजी के संगठन की होनी चाहिए; मालिक की व्यक्तिगत कुंजी या दूसरे संगठन की कुंजी दोनों के लिए 404 मिलता है और अस्तित्व का पता नहीं चलता। उत्तर का आकार { data: <key>, key: <key> } है और दोनों fields में एक ही object होता है। <key> में limit, limit_remaining, limit_reset, usage, usage_daily/weekly/monthly, requests, requests_daily/weekly/monthly और usage_scope: key होते हैं। उपयोग के मान उस कुंजी के साथ GET /v1/key के मानों से मेल खाते हैं। limit_remaining रीसेट अवधि में कुंजी के खर्च को घटाने के बाद की सीमा है; अलग सीमा न होने पर यह कुंजी द्वारा उपयोग किया जाने वाला account या organization balance है। वास्तविक secret नहीं लौटाया जाता।

GET/v1/keys/:id

प्राधिकरण

Authorizationआवश्यक

string · header

Authorization हेडर में bearer token के रूप में API कुंजी।

पथ पैरामीटर

idआवश्यक

string

प्राप्त की जाने वाली API कुंजी का ID।

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 होता है और 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
  }
}