توثيق الـ API

نظرة عامة

تتيح لك واجهة Orbitex API دمج عمليات الضغط والدمج والتقسيم والتحويل في تطبيقاتك وبرامجك النصية وخطوط التكامل المستمر. كل الطلبات تستخدم HTTPS وتتطلب مفتاح API.

الواجهة قيد التطوير. ستُنشر هنا نقاط النهاية وحدود المعدل وتفاصيل المصادقة قبل الإصدار التجريبي العام.

المصادقة

تتضمن الطلبات ترويسة Authorization تحمل مفتاح API الخاص بك:

• تُنشأ المفاتيح في لوحة تحكم Orbitex (خطة الأعمال).
• بدِّل المفتاح من لوحة التحكم إن تعرَّض للاختراق.
• لا تكشف المفاتيح أبدًا في JavaScript على جانب العميل أو في مستودعات عامة.

نقاط النهاية المخطط لها

ستشمل النسخة الأولى من الواجهة ما يلي:

• POST /v1/pdf/compress - تقليل حجم ملف PDF
• POST /v1/pdf/merge - دمج عدة ملفات PDF
• POST /v1/pdf/split - التقسيم حسب الصفحات أو النطاقات
• POST /v1/pdf/convert - من PDF إلى Word وExcel والعكس
• POST /v1/pdf/protect - التشفير بكلمة مرور
• GET /v1/jobs/{id} - الاستعلام عن حالة مهمة غير متزامنة

التعامل مع الملفات

تخضع الملفات المرفوعة لقواعد الأمان والحذف نفسها المطبقة في واجهة الويب. راجع سياسة أمان الملفات لمعرفة مدد الاحتفاظ وتفاصيل التشفير.

ستُخطر الـ webhooks خادمك عند اكتمال المهام الطويلة.

حدود المعدل

تعتمد حدود المعدل على مستوى الخطة. لا يوجد وصول إلى الـ API في الخطة المجانية. ويحصل عملاء الأعمال على حدود موثَّقة وهوامش للذروة.

احصل على وصول مبكر

أخبرنا عن حالة استخدامك، من تحويل دفعي إلى خطوط معالجة للمستندات إلى تكامل مع خدمة سحابية، وسنُعلمك عند فتح الإصدار التجريبي.