إدارة API Key

API Key نقاط النهاية الإدارية تقبل فقط JWT المصادقة.

أنشئ API Key

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

معايير الطلب:

المعلمة	النوع	مطلوب	الوصف
`label`	string	نعم	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 مفاتيح

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

حقول الاستجابة:

الميدان	النوع	الوصف
`list[].id`	string	API Key ID
`list[].label`	string	العلامة التجارية
`list[].apiKey`	string	معرف API Key العام
`list[].permissions`	الاستخبارات	قناع البت الخاص بالإذن
`list[].ipWhitelist`	الوترية[]	IP القائمة البيضاء
`list[].status`	الاستخبارات	الحالة: `1` مفعل، `0` معطلة
`list[].lastUsedAt`	int64	آخر وقت مستخدم
`list[].createdAt`	int64	زمن الخلق

تحديث API Key

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

معايير الطلب:

المعلمة	النوع	مطلوب	الوصف
`id`	string	نعم	API Key ID
`label`	string	لا	شركة الإنتاج الجديدة
`permissions`	الاستخبارات	لا	قناع بت للإذن الجديد
`ipWhitelist`	الوترية[]	لا	القائمة البيضاء الجديدة IP
`status`	الاستخبارات	لا	`1` مفعل، `0` معطلة

حذف API Key

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

نص الطلب:

1 { "id": "1001" }

حذف جميع API المفاتيح

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