قائمة مفاتيح API

GET /v1/api-keys

قائمة جميع مفاتيح API النشطة (غير الملغاة) للمستخدم المصادق عليه. لا تتضمن الاستجابة أبداً قيم المفاتيح الخام أو التجزئات -- فقط البيانات الوصفية للتعريف والإدارة.

جرّبه

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

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

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

الطلب

الترويسات

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

لا تقبل نقطة النهاية هذه أي معاملات استعلام أو جسم طلب.

أمثلة الكود

curl

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

TypeScript

const apiKey = process.env.DOCMAP_API_KEY

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

const { data } = await response.json()

for (const key of data) {
  console.log(`${key.name} (${key.prefix}...) — created ${key.createdAt}`)
}

Python

import requests

api_key = "dm_live_abc123def456ghi789jkl012mno345"

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

keys = response.json()["data"]

for key in keys:
    print(f"{key['name']} ({key['prefix']}...) — created {key['createdAt']}")

الاستجابة

الحالة: 200 OK

يحتوي جسم الاستجابة على مصفوفة data من كائنات البيانات الوصفية لمفاتيح API.

الحقول

يحتوي كل كائن في المصفوفة على:

الحقل	النوع	الوصف
id	string	معرّف فريد لمفتاح API.
userId	string	معرّف المستخدم الذي يملك المفتاح.
name	string	تسمية وصفية للمفتاح.
prefix	string	الأحرف الأولى من المفتاح للتعريف (مثال: dm_live_abc1).
expiresAt	string | null	طابع زمني ISO 8601 لانتهاء الصلاحية، أو null إذا كان المفتاح لا ينتهي أبداً.
lastUsedAt	string | null	طابع زمني ISO 8601 لآخر مرة استُخدم فيها المفتاح. null إذا لم يُستخدم أبداً.
createdAt	string	طابع زمني ISO 8601 لوقت إنشاء المفتاح.
revoked	boolean	ما إذا كان المفتاح قد تم إلغاؤه. دائماً false في هذه الاستجابة لأن المفاتيح النشطة فقط تُرجع.

مثال

{
  "data": [
    {
      "id": "ak_1a2b3c4d5e6f7g8h",
      "userId": "uid_a1b2c3d4e5f6",
      "name": "Production Server",
      "prefix": "dm_live_r4nd",
      "expiresAt": "2025-02-18T10:00:00.000Z",
      "lastUsedAt": "2024-11-20T16:45:00.000Z",
      "createdAt": "2024-11-20T10:00:00.000Z",
      "revoked": false
    },
    {
      "id": "ak_9i8h7g6f5e4d3c2b",
      "userId": "uid_a1b2c3d4e5f6",
      "name": "Local Development",
      "prefix": "dm_live_t3st",
      "expiresAt": null,
      "lastUsedAt": "2024-11-19T08:30:00.000Z",
      "createdAt": "2024-10-05T12:00:00.000Z",
      "revoked": false
    }
  ]
}

الأخطاء

الحالة	الرمز	الوصف
401	UNAUTHORIZED	مفتاح API / رمز مفقود أو غير صالح أو منتهي الصلاحية.