KodaPdf الوثائق والأدلة

المصادقة وإدارة مفاتيح API

تستخدم واجهة برمجة التطبيقات (API) مصادقة JWT لجميع نقاط نهاية المطور. يجب تضمين مفتاح API الفريد الخاص بك في رأس كل طلب. مفتاح واجهة برمجة تطبيقات المطور تم إنشاؤها من إعدادات ملف التعريف الخاص بك.

X-Api-Key: Your_Developer_API_Key
Content-Type: application/json

الخطوة 1: تحميل الملف للتحويل

قبل إجراء عمليات عبر واجهة برمجة التطبيقات، يجب عليك تحميل ملفاتك إلى النظام. تقبل نقطة النهاية هذه بيانات متعددة الأجزاء/النموذج الحمولات.

مثال للطلب (تحديد حسب اللغة):

curl -X POST "https://kodapdf.com/api/files/upload" \
  -H "X-Api-Key: Your_Developer_API_Key" \
  -F "file=@report.docx"

استجابة ناجحة (JSON - 201 تم الإنشاء):

{
  "fileId": "8a7c93e4-b78f-4ad5-9c60-06123456789a",
  "fileName": "report.docx",
  "size": 4194304
}

رموز استجابة HTTP:

الخطوة 2: تدفق قائمة انتظار المهام غير المتزامنة

بعد تحميل ملف وتلقي معرف الملف ، يمكنك تشغيل مهمة الخلفية من خلال تقديم طلب إلى نقطة التحويل المستهدفة أو نقطة معالجة PDF. بمجرد الانتهاء، ستحصل على رابط التنزيل الآمن.

تتبع حالة الوظيفة (الاستطلاع أو خطافات الويب)

استعلم عن حالة الوظيفة على فترات منتظمة (GET) باستخدام المعرف المُرجع معرف الوظيفة في نقطة نهاية URL التالية:

مثال استعلام الوظيفة:

curl -X GET "https://kodapdf.com/api/jobs/e4f8d22c-a2b1-4f33-bd54-72123456789b" \
  -H "X-Api-Key: Your_Developer_API_Key"

الاستجابة المرتجعة (تم إكمال الوظيفة بنجاح):

{
  "id": "e4f8d22c-a2b1-4f33-bd54-72123456789b",
  "status": "Completed",
  "fileName": "report.pdf",
  "downloadUrl": "https://kodapdf.com/api/jobs/e4f8d22c-a2b1-4f33-bd54-72123456789b/download"
}

حالات دورة حياة الوظيفة:

مرجع نقاط نهاية REST API

فيما يلي معلمات المهام غير المتزامنة وقوالب API الأكثر طلبًا. بمجرد تحميل ملف، قم بتمرير معرّفه المُرجع معرف الملف ضمن جسم حمولة JSON:

curl -X POST "https://kodapdf.com/api/jobs" \
  -H "X-Api-Key: Your_Developer_API_Key" \
  -H "Content-Type: application/json" \
  -d '{
    "fileId": "8a7c93e4-b78f-4ad5-9c60-06123456789a",
    "sourceFormat": "docx",
    "targetFormat": "pdf",
    "originalFileName": "report.docx"
  }'

{
  "fileIds": [
    "8a7c93e4-b78f-4ad5-9c60-06123456789a",
    "9b8d04f5-c89g-5be6-0d71-1723456789ab"
  ],
  "outputFileName": "merged_document.pdf"
}

{
  "fileId": "8a7c93e4-b78f-4ad5-9c60-06123456789a",
  "text": "CONFIDENTIAL",
  "opacity": 0.25,
  "outputFileName": "watermarked.pdf"
}

{
  "fileId": "8a7c93e4-b78f-4ad5-9c60-06123456789a",
  "patterns": ["SECRET", "05\\d{9}"],
  "outputFileName": "redacted.pdf"
}

إشعارات خطاف الويب (واجهات برمجة تطبيقات رد الاتصال)

يدعم نظامنا اشتراكات Webhook الآلية التي تتصل بخدمات الويب الخاصة بك مباشرة عند اكتمال الوظيفة، مما يؤدي إلى تجنب الاستطلاع اليدوي عبر استعلامات GET. بريد /api/Webhook/subscribe

نص طلب الاشتراك:

{
  "target_url": "https://api.yoursite.com/kodapdf-callback",
  "event_type": "job.completed"
}

JSON (الحمولة) المرسلة إلى خادمك عند اكتمال الوظيفة:

{
  "id": "e4f8d22c-a2b1-4f33-bd54-72123456789b",
  "fileName": "report.pdf",
  "status": "Completed",
  "sourceFormat": "docx",
  "targetFormat": "pdf",
  "downloadUrl": "https://kodapdf.com/api/jobs/e4f8d22c-a2b1-4f33-bd54-72123456789b/download",
  "event_type": "job.completed"
}