إلغاء مفتاح API

DELETE /v1/api-keys/{id}

إلغاء مفتاح API فوراً. بمجرد الإلغاء، سيتم رفض أي طلبات تستخدم هذا المفتاح بخطأ 401 UNAUTHORIZED.

جرّبه

اختبر هذا الـ endpoint بشكل تفاعلي في Swagger UI.

المصادقة مطلوبة

أدرج مفتاح API في ترويسة Authorization.

DANGER

إلغاء المفتاح فوري ودائم. ستفقد أي أنظمة تستخدم هذا المفتاح الوصول فوراً. لا يمكن التراجع عن هذا الإجراء -- ستحتاج إلى إنشاء مفتاح جديد وتحديث أنظمتك.

الطلب

الترويسات

الترويسة	القيمة	مطلوب
`Authorization`	`Bearer <token>`	نعم

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

المعامل	النوع	مطلوب	الوصف
`id`	`string`	نعم	معرّف مفتاح API المراد إلغاؤه (مثال: `ak_1a2b3c4d5e6f7g8h`).

أمثلة الكود

curlTypeScriptPython

bash

curl -X DELETE https://api.docmap.io/v1/api-keys/ak_1a2b3c4d5e6f7g8h \
  -H "Authorization: Bearer dm_live_abc123def456ghi789jkl012mno345"

typescript

const apiKey = process.env.DOCMAP_API_KEY
const keyId = 'ak_1a2b3c4d5e6f7g8h'

const response = await fetch(
  `https://api.docmap.io/v1/api-keys/${keyId}`,
  {
    method: 'DELETE',
    headers: { 'Authorization': `Bearer ${apiKey}` },
  },
)

const result = await response.json()
console.log(result) // { success: true }

python

import requests

api_key = "dm_live_abc123def456ghi789jkl012mno345"
key_id = "ak_1a2b3c4d5e6f7g8h"

response = requests.delete(
    f"https://api.docmap.io/v1/api-keys/{key_id}",
    headers={"Authorization": f"Bearer {api_key}"},
)

print(response.json())  # {"success": True}

الاستجابة

الحالة: 200 OK

مثال

json

{
  "success": true
}

الأخطاء

الحالة	الرمز	الوصف
`401`	`UNAUTHORIZED`	مفتاح API / رمز مفقود أو غير صالح أو منتهي الصلاحية.
`403`	`FORBIDDEN`	مفتاح API ينتمي إلى مستخدم آخر. يمكنك فقط إلغاء مفاتيحك الخاصة.
`404`	`NOT_FOUND`	لم يُعثر على مفتاح API بالمعرّف المحدد.

إلغاء مفتاح API ​

الطلب ​

الترويسات ​

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

أمثلة الكود ​

الاستجابة ​

مثال ​

الأخطاء ​