الحصول على الاستخدام

GET /v1/usage

احصل على استخدام الاستخراج الحالي لفترة الفوترة الخاصة بالمستخدم المصادق عليه. استخدم نقطة النهاية هذه لمراقبة الاستهلاك وتجنب الوصول إلى حدود الخطة.

جرّبه

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

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

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

الطلب

الترويسات

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

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

أمثلة الكود

curl

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

TypeScript

const apiKey = process.env.DOCMAP_API_KEY

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

const { data } = await response.json()
console.log(`${data.usage} / ${data.limit} extractions used (${data.plan} plan)`)

Python

import requests

api_key = "dm_live_abc123def456ghi789jkl012mno345"

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

data = response.json()["data"]
print(f"{data['usage']} / {data['limit']} extractions used ({data['plan']} plan)")

الاستجابة

الحالة: 200 OK

جسم الاستجابة مغلف في كائن data.

الحقول

الحقل	النوع	الوصف
plan	string	خطة المستخدم الحالية: free أو starter أو core أو pro.
usage	number	عدد عمليات الاستخراج المستهلكة في فترة الفوترة الحالية.
limit	number	الحد الأقصى لعمليات الاستخراج المسموح بها للخطة الحالية.
periodKey	string	فترة الفوترة الحالية بتنسيق YYYY-MM.

مثال

{
  "data": {
    "plan": "starter",
    "usage": 142,
    "limit": 500,
    "periodKey": "2024-11"
  }
}

الأخطاء

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