انتقل إلى المحتوى
Sursa Developers

مرجع API

واجهة Sursa API العامة: 222 من نقاط النهاية في 35 من الأقسام. الإصدار 1.62.0.

واجهة Sursa API العامة للتكاملات التي تُصادَق بمفتاح API. التغييرات داخل /v1 تغييرات بالإضافة: قد تظهر عمليات جديدة ومعاملات اختيارية وحقول استجابة وقيم تعداد جديدة في الاستجابات، ويستمر العملاء الحاليون في العمل. تعامل مع قيم التعداد غير المعروفة في الاستجابات على أنها صالحة.

عنوان URL الأساسي
https://api.sursa.com
المصادقة
أرسل مفتاح API في الترويسة Authorization: Authorization: Bearer <key>.

الأقسام

healthنقطة نهاية واحدة

حالة الخدمة وإصدارها

authنقطة نهاية واحدة

تسجيل الدخول، والجلسات، ووضع «View as» (عرض بصفة)، وتغيير كلمة المرور وإعادة تعيينها، وقبول الدعوات

users5 نقاط نهاية

حسابات مستخدمي المؤسسة

api-keys9 نقاط نهاية

مفاتيح API للمؤسسة

apps8 نقاط نهاية

تطبيقات OAuth للمؤسسة وتخويلات الموظفين

oauth3 نقاط نهاية

بروتوكول OAuth 2.0: شاشة الموافقة، وإصدار الرموز وإبطالها، والبيانات الوصفية لخادم التخويل

audit4 نقاط نهاية

سجل التدقيق للمؤسسة

orgنقطة نهاية واحدة

المؤسسة وشعارها وتصدير بياناتها

categories4 نقاط نهاية

فئات المستندات

collections6 نقاط نهاية

مجموعات المعرفة

cards26 نقطة نهاية

بطاقات المعرفة: الرفع، والمحتوى، والجداول، والإصدارات، والتوثيق، والتعليقات

jobs5 نقاط نهاية

قائمة انتظار الفهرسة: مهام المعالجة، ومعاينة قراءة المستند، وتدفق التغييرات (SSE)

conversationsنقطتا نهاية

المحادثات مع المساعد

answers3 نقاط نهاية

البحث وإجابات المساعد، بما في ذلك تدفق SSE

access-requests4 نقاط نهاية

طلبات الوصول إلى مصادر إجابة مخفية

questions10 نقاط نهاية

سجل الأسئلة، والاقتراحات، وتصدير الإجابات، والإجابة الحية

files8 نقاط نهاية

ملفات التصدير

insightsنقطة نهاية واحدة

تحليلات المعرفة: الملخص، والتكرارات، وثغرات المعرفة، وصحة المعرفة

tasksنقطة نهاية واحدة

مهام المستخدم ومهام الفريق

sources19 نقطة نهاية

مصادر البيانات، مثل Google Drive وConfluence

permissions17 نقطة نهاية

نظام الوصول: سجل الصلاحيات، والصلاحيات على المؤسسة والمجموعات والبطاقات والمصادر، الممنوحة مباشرة والموروثة

roles4 نقاط نهاية

الأدوار: مجموعات مسمّاة من الصلاحيات، مدمجة ومخصصة

groups7 نقاط نهاية

مجموعات المستخدمين: المجموعات العادية، و«All members» (كل الأعضاء)، ومجموعات الأدوار، والمجموعات الشخصية

folders7 نقاط نهاية

مجلدات المجموعة: شجرة بعمق يصل إلى ثلاثة مستويات، والترتيب بالنسبة إلى عنصر مجاور، وبطاقة واحدة في عدة مجلدات، والصلاحيات الموروثة

catalog6 نقاط نهاية

دليل الخدمات الخارجية (خدمات SaaS والموردون) بأسمائها ومواقعها الإلكترونية وفئاتها وأيقوناتها وأوصافها، والروابط بين الأسماء المستخدمة في مؤسستك وعناصر الدليل

drafts6 نقاط نهاية

المسودات واعتماد النشر

verification9 نقاط نهاية

التوثيق: الحالة، ومواعيد المراجعة، والموثِّقون، والسجل، وقائمة «وثّق أولًا»، ومؤشر الثقة، وإخراج المستخدمين من المؤسسة

announcements5 نقاط نهاية

إعلانات للقراءة الإلزامية: الجمهور، وتأكيد القراءة، والتقارير، والتذكيرات، والتصدير

comments4 نقاط نهاية

سلاسل التعليقات على البطاقات، مع مرسى في النص وحالة، والتفاعلات

webhooks17 نقطة نهاية

خطافات الويب للمؤسسة: الخطافات نفسها، والاشتراكات في الأحداث، والتوقيعات، والتسليمات، وإعادة المحاولة

public-apiنقطة نهاية واحدة

واجهة API العامة للتكاملات: المواصفة المقروءة آليًا لهذه الواجهة

uploads5 نقاط نهاية

الرفع متعدد الأجزاء للملفات الكبيرة: الجلسة، والأجزاء، والإكمال مع الفحوص، والاستخدام في بطاقة أو أرشيف أو استيراد

analytics4 نقاط نهاية

تحليلات المنتج: أحداث الاستخدام، والعدادات لكل كائن، ولوحات معلومات الصحة والاستخدام والمساهمات، وتقرير التجديد، والتصدير

quality3 نقاط نهاية

جودة الإجابات: الأسئلة التي لم تحصل على إجابة جيدة، وثغرات المعرفة المأخوذة للعمل عليها

finance6 نقاط نهاية

المستندات المالية: أسعار الصرف ودليل الأطراف المقابلة

الكائنات