المشاريع، والوسوم، والمشاركة
تُعد مكتبة الملفات مصدر الحقيقة للموارد؛ أما المشاريع والوسوم والبحث فهي طرق عرض تُنظِّم هذه الموارد. احتفظ بمعرّفات الملفات أو المستندات؛ ولا تستخدم الأسماء بدلًا من المعرّفات الثابتة.
مشاريع
Section titled “مشاريع”GET /api/v1/projectsPOST /api/v1/projectsGET /api/v1/projects/{project_id}PATCH /api/v1/projects/{project_id}DELETE /api/v1/projects/{project_id}
POST /api/v1/projects/{project_id}/documentsDELETE /api/v1/projects/{project_id}/documents/{document_id}إضافة مستند إلى مشروع لا تؤثر إلا على تنظيمه: لا يتم نسخ الملف ولا يتغير مالكه.
الوسوم
Section titled “الوسوم”GET /api/v1/tagsPOST /api/v1/tagsDELETE /api/v1/tags/{tag_id}
POST /api/v1/tags/documents/{document_id}DELETE /api/v1/tags/documents/{document_id}/{tag_id}اسم الوسم مخصص للعرض؛ أما الحذف والفصل والاستعلام فتتم باستخدام معرّف الوسم.
GET /api/v1/search?q={query}&limit=20تُرجع عمليات البحث المستندات والوظائف التي يُسمح للحساب الحالي بقراءتها فقط. تُعدّ عمليات البحث عمليات قراءة ولا تُحتسب مقابلها أرصدة.
مشاركة الروابط
Section titled “مشاركة الروابط”GET /api/v1/sharesPOST /api/v1/sharesGET /api/v1/shares/{token}GET /api/v1/shares/{token}/downloadDELETE /api/v1/shares/{token}يُنشئ POST /shares رابطًا للقراءة فقط إلى نتيجة الترجمة؛ ويحتوي النص على artifact_id وexpires_in_days اختياري (من 1 إلى 365؛ وإذا لم يُحدَّد، فلن تنتهي صلاحية الرابط). يمكن لأي شخص يمتلك الرابط تنزيل المحتوى، لذا احرص على عدم تسجيله في السجلات أو في معلمات التحليلات، واحذفه عند عدم الحاجة إليه.
مساحة عمل التطبيق
Section titled “مساحة عمل التطبيق”GET /api/v1/workspace/filesGET /api/v1/workspace/entriesGET /api/v1/workspace/appsتُستخدم هذه النقاط النهائية لإنشاء مساحة عمل موحدة لحساب OmniDoc. يجب على العملاء اتباع الإدخالات والإمكانيات الواردة في الاستجابات وعدم إنشاء عناوين URL للتطبيقات بأنفسهم.