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

المشاريع، والوسوم، والمشاركة

تُعد مكتبة الملفات مصدر الحقيقة للموارد؛ أما المشاريع والوسوم والبحث فهي طرق عرض تُنظِّم هذه الموارد. احتفظ بمعرّفات الملفات أو المستندات؛ ولا تستخدم الأسماء بدلًا من المعرّفات الثابتة.

GET /api/v1/projects
POST /api/v1/projects
GET /api/v1/projects/{project_id}
PATCH /api/v1/projects/{project_id}
DELETE /api/v1/projects/{project_id}
POST /api/v1/projects/{project_id}/documents
DELETE /api/v1/projects/{project_id}/documents/{document_id}

إضافة مستند إلى مشروع لا تؤثر إلا على تنظيمه: لا يتم نسخ الملف ولا يتغير مالكه.

GET /api/v1/tags
POST /api/v1/tags
DELETE /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

تُرجع عمليات البحث المستندات والوظائف التي يُسمح للحساب الحالي بقراءتها فقط. تُعدّ عمليات البحث عمليات قراءة ولا تُحتسب مقابلها أرصدة.

GET /api/v1/shares
POST /api/v1/shares
GET /api/v1/shares/{token}
GET /api/v1/shares/{token}/download
DELETE /api/v1/shares/{token}

يُنشئ POST /shares رابطًا للقراءة فقط إلى نتيجة الترجمة؛ ويحتوي النص على artifact_id وexpires_in_days اختياري (من 1 إلى 365؛ وإذا لم يُحدَّد، فلن تنتهي صلاحية الرابط). يمكن لأي شخص يمتلك الرابط تنزيل المحتوى، لذا احرص على عدم تسجيله في السجلات أو في معلمات التحليلات، واحذفه عند عدم الحاجة إليه.

GET /api/v1/workspace/files
GET /api/v1/workspace/entries
GET /api/v1/workspace/apps

تُستخدم هذه النقاط النهائية لإنشاء مساحة عمل موحدة لحساب OmniDoc. يجب على العملاء اتباع الإدخالات والإمكانيات الواردة في الاستجابات وعدم إنشاء عناوين URL للتطبيقات بأنفسهم.