الإدارة

تحديث مفتاح API

يحدّث مفتاح API مستخدم موجودًا في المؤسسة الحالية.

PATCHhttps://api.tokenlab.sh/v1/management/api-keys/{keyId}

نظرة عامة

استخدم هذا الـ endpoint لتحديث الاسم أو حد الاستخدام أو النماذج المسموح بها أو وقت الانتهاء أو الحالة الخاصة بمفتاح API موجود.

جسم الطلب

يجب أن يتضمن طلب PATCH حقلًا واحدًا على الأقل.

الحقلالنوعالقيم الافتراضية / القيودالوصف
statusenum-active, inactive, revoked
namestringالطول 1-50اسم العرض بعد التحديث
limitAmountnumber | string | null0–100000 USDتعني null عدم وجود حد، وتمنع 0 الإنفاق. تدعم السلاسل العشرية حتى 6 منازل عشرية.
limitCurrencyتعدادافتراضي USDUSD فقط. إرسال CNY يُرجع 400 currency_retired. عند تحديده، يجب أيضًا إرسال limitAmount.
modelsstring[]-قائمة النماذج المنطقية المسموح بها بعد التحديث
deliveryPolicystring | nullauto, verified, official, nullتعني null وراثة سياسة التسليم لمساحة العمل.
expiresAtstring | nullتاريخ ووقت RFC3339null يزيل وقت الانتهاء

ملاحظات

  • تدعم حقول المبالغ المالية الدولار الأمريكي فقط. تم إيقاف مدخلات CNY وتعيد 400 currency_retired.

  • لا يدعم Management API v1 الحذف النهائي عمدًا.

  • تُعامل الحالة revoked عادةً كحالة نهائية للاستخدام التشغيلي العادي؛ وإذا احتجت إلى مفتاح جديد، فأنشئ مفتاحًا جديدًا بدلًا من توقع وجود مسار لاحق لفك الإلغاء.

مثال

الطلب

cURL
curl -X PATCH "https://api.tokenlab.sh/v1/management/api-keys/key_abc123def456" \
  -H "Authorization: Bearer mt-your-management-token" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "inactive",
    "limitAmount": 0
  }'

الطلب / الاستجابة

توفّر هذه الصفحة مخطط OpenAPI وأمثلة طلبات قابلة للنسخ. أرسل طلبات الإدارة من الطرفية أو برنامج العميل باستخدام Management Token؛ لا يتوفر الإرسال المباشر من هذه الصفحة.

الاستجابة

200 OK
{
  "id": "key_abc123def456",
  "name": "Backend Worker",
  "key_prefix": "sk-live...",
  "status": "inactive",
  "limit_amount": 0,
  "limit_amount_decimal": "0",
  "used_amount": 148.25,
  "used_amount_decimal": "148.25",
  "models": [
    "gpt-5.6-luna",
    "claude-3-7-sonnet"
  ],
  "expires_at": "2026-12-31T23:59:59.000Z",
  "last_used_at": "2026-07-08T03:12:45.000Z",
  "created_at": "2026-07-01T10:00:00.000Z",
  "delivery_policy": null
}

الحقول المهمة

idstring
معرّف مفتاح API المستخدم في استدعاءات واجهة API للإدارة اللاحقة.
namestring
اسم العرض لمفتاح API.
key_prefixstring
بادئة مفتاح غير سرية للعرض والدعم.
statusstring
إحدى القيم active أو inactive أو suspended أو revoked.
limit_amountnumber | null
حد الإنفاق بالدولار الأمريكي كرقم JSON للعرض. تعني null عدم وجود حد.
limit_amount_decimalstring | null
حد الإنفاق الدقيق بالدولار الأمريكي كسلسلة عشرية. تعني null عدم وجود حد.
used_amountnumber
الإنفاق التراكمي للاستخدام بالدولار الأمريكي كرقم JSON للعرض.
used_amount_decimalstring
الإنفاق التراكمي الدقيق للاستخدام بالدولار الأمريكي كسلسلة عشرية.
modelsstring[]
قائمة النماذج المسموح بها لكل مفتاح. تعني المصفوفة الفارغة عدم وجود قيود إضافية على النماذج على مستوى المفتاح.
delivery_policystring | null
auto, verified, official, null. تعني null وراثة سياسة التسليم لمساحة العمل.
expires_atstring | null
طابع زمني ISO لانتهاء صلاحية المفتاح، أو null إذا لم تكن له مدة انتهاء.
last_used_atstring | null
طابع زمني ISO لأحدث استخدام، أو null إذا لم يُستخدم.
created_atstring
طابع زمني ISO للإنشاء.

التفويض

ManagementTokenAuth
AuthorizationBearer <token>

مصادقة رمز الإدارة (Management token). قم بإنشاء أو إدارة رموز الإدارة في Dashboard > API > Management Tokens.

الموضع: header

معاملات المسار

keyId*string

جسم الطلب

application/json

يجب توفير حقل واحد على الأقل.

الخصائص1 <= properties

الاستجابة

application/json

application/json

application/json

application/json

application/json

application/json