نظرة عامة على API

يوفر DocMap API نقاط نهاية REST لاستخراج البيانات المنظمة من مستندات PDF باستخدام قوالب مدعومة بالذكاء الاصطناعي.

عنوان URL الأساسي

تُرسل جميع طلبات API إلى:

https://api.docmap.io

جميع نقاط النهاية المُصدّرة مسبوقة بـ /v1/.

تتطلب جميع نقاط النهاية /v1/* ترويسة Authorization مع رمز Bearer. يمكنك استخدام إما مفتاح API أو رمز Firebase ID:

Authorization: Bearer dm_live_abc123def456ghi789jkl012mno345

يمكن إنشاء مفاتيح API وإدارتها من لوحة التحكم > الإعدادات > مفاتيح API أو عبر نقاط نهاية مفاتيح API. راجع دليل المصادقة للتفاصيل.

تستخدم جميع أجسام الطلبات والاستجابات JSON:

Content-Type: application/json

تخضع طلبات الاستخراج لحدود شهرية بناءً على خطتك. استخدم نقطة النهاية GET /v1/usage للتحقق من استهلاكك الحالي. راجع دليل حدود المعدل لحصص كل خطة.

الطريقة	المسار	الوصف
`GET`	`/health`	فحص الصحة (بدون مصادقة)
`POST`	`/v1/extractions/run`	تشغيل استخراج على مستند PDF
`GET`	`/v1/extractions`	قائمة سجلات الاستخراج
`DELETE`	`/v1/extractions/{id}`	حذف سجل استخراج
`GET`	`/v1/usage`	الحصول على الاستخدام الحالي لفترة الفوترة
`POST`	`/v1/api-keys`	إنشاء مفتاح API جديد
`GET`	`/v1/api-keys`	قائمة جميع مفاتيح API النشطة
`DELETE`	`/v1/api-keys/{id}`	إلغاء مفتاح API

GET /health هي نقطة النهاية الوحيدة غير المصادق عليها. استخدمها للتحقق من إمكانية الوصول إلى API.

curlTypeScriptPython

bash

curl https://api.docmap.io/health

typescript

const res = await fetch('https://api.docmap.io/health')
const data = await res.json()
console.log(data) // { status: "ok" }

python

import requests

res = requests.get("https://api.docmap.io/health")
print(res.json())  # {"status": "ok"}

الاستجابة:

json

{ "status": "ok" }

تتبع جميع استجابات الأخطاء بنية متسقة:

json

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or expired API key."
  }
}

راجع مرجع رموز الأخطاء للحصول على قائمة كاملة برموز الأخطاء ومعانيها.

مواصفة OpenAPI الكاملة متاحة للأدوات وتوليد العملاء: