تخطَّ إلى المحتوى

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

تخدم واجهة برمجة التطبيقات OmniDoc سير عمل الملفات والمحتوى ضمن حساب واحد. يقوم المتصل بإنشاء الموارد باستخدام مفتاح واجهة برمجة التطبيقات، ثم يستخدم المعرّفات الثابتة التي يحصل عليها للاستعلام عنها أو دمجها أو معالجتها أو تنزيلها.

الموردالغرض
مستند / ملفالملفات المصدر وإدخالات مكتبة الملفات المملوكة للحساب
وظيفة / عمليةوظائف الترجمة غير المتزامنة، ومعالجة المستندات، أو الصوت والفيديو
Artifactالنتائج التي يقدمها الوظيفة للمعاينة أو التنزيل
عملية الائتمانسجل ما تم فرضه وردّه مقابل إجراء واحد قابل للتحصيل

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

  1. أنشئ مورد إدخال أو اختر واحدًا.
  2. تأكد من وجود رصيد في الحساب: يتم فحص الرصيد مقارنةً بعتبة معينة قبل بدء المهمة، ويتم تحصيل التكلفة الفعلية عند اكتمالها.
  3. أنشئ المهمة باستخدام Idempotency-Key.
  4. تحقق من حالة المهمة؛ يمكن لمهام ترجمة الملفات أيضًا استخدام SSE أو webhooks.
  5. اطّلع على النتائج وسجل الائتمان لهذا المهمة.

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