نظرة عامة على المنصة
تخدم واجهة برمجة التطبيقات OmniDoc سير عمل الملفات والمحتوى ضمن حساب واحد. يقوم المتصل بإنشاء الموارد باستخدام مفتاح واجهة برمجة التطبيقات، ثم يستخدم المعرّفات الثابتة التي يحصل عليها للاستعلام عنها أو دمجها أو معالجتها أو تنزيلها.
نموذج الموارد
Section titled “نموذج الموارد”| المورد | الغرض |
|---|---|
| مستند / ملف | الملفات المصدر وإدخالات مكتبة الملفات المملوكة للحساب |
| وظيفة / عملية | وظائف الترجمة غير المتزامنة، ومعالجة المستندات، أو الصوت والفيديو |
| Artifact | النتائج التي يقدمها الوظيفة للمعاينة أو التنزيل |
| عملية الائتمان | سجل ما تم فرضه وردّه مقابل إجراء واحد قابل للتحصيل |
يتم فحص كل مورد مقابل الحساب المالك. يتعين على العملاء الاحتفاظ بالمعرّفات العامة فقط، ويجب ألا يستنبطوا تفاصيل التنفيذ من المعرّفات أو أسماء الملفات أو عناوين التنزيل.
سير المكالمات الشائع
Section titled “سير المكالمات الشائع”- أنشئ مورد إدخال أو اختر واحدًا.
- تأكد من وجود رصيد في الحساب: يتم فحص الرصيد مقارنةً بعتبة معينة قبل بدء المهمة، ويتم تحصيل التكلفة الفعلية عند اكتمالها.
- أنشئ المهمة باستخدام
Idempotency-Key. - تحقق من حالة المهمة؛ يمكن لمهام ترجمة الملفات أيضًا استخدام SSE أو webhooks.
- اطّلع على النتائج وسجل الائتمان لهذا المهمة.
الهوية
Section titled “الهوية”تستخدم عمليات التكامل الخارجية دائمًا مفاتيح واجهة برمجة التطبيقات، بنفس الأذونات الخاصة بالحساب الذي أنشأ المفتاح. انظر المصادقة .
البدء السريع → حمّل ملفًا، وأنشئ مهمة، وتحقق من حالتها، وقم بتنزيل النتائج