مرجع API

يمكنك توثيق واجهات برمجة التطبيقات باستخدام إما OAuth2 أو مفاتيح API. OAuth2 هو إطار عمل قياسي للتفويض يمكّن التطبيقات من الوصول بشكل آمن إلى مستندات محددة داخل نظام ما. من ناحية أخرى، توفر مفاتيح API طريقة أبسط لاسترجاع المستندات من قاعدة معرفة مشتركة دون الحاجة للخضوع لعملية توثيق OAuth2.

نظرة عامة على واجهة برمجة التطبيقات

توفر Rememberizer مجموعة شاملة من واجهات برمجة التطبيقات للعمل مع الوثائق، ومتاجر المتجهات، والذكريات، والمزيد. تم تنظيم واجهات برمجة التطبيقات في الفئات التالية:

واجهات برمجة التطبيقات للمصادقة

• التسجيل، تسجيل الدخول، التحقق من البريد الإلكتروني

• إعادة تعيين كلمة المرور

• نقاط نهاية OAuth (جوجل، مايكروسوفت)

• إدارة الرموز وتسجيل الخروج

واجهات برمجة التطبيقات للمستخدم

• ملف تعريف المستخدم ومعلومات الحساب

• إدخال المستخدم

واجهات برمجة تطبيقات الوثائق

• قائمة، إنشاء، وتحديث الوثائق

• معالجة الوثائق

• عمليات الوثائق الجماعية

واجهات برمجة التطبيقات للبحث

• البحث الأساسي

• البحث الوكالي

• عمليات البحث الدفعي

واجهات برمجة التطبيقات للذكريات

• إنشاء، قائمة، تحديث، وحذف الذكريات

• إدارة مستندات الذكريات

واجهات برمجة تطبيقات تخزين المتجهات

• إنشاء قوائم تخزين المتجهات

• رفع النصوص والمستندات

• البحث في تخزين المتجهات

• رفع وبحث دفعات

واجهات برمجة التطبيقات للتكاملات

• قائمة التكاملات

• نقاط نهاية تكامل OAuth (Google Drive، Gmail، Slack، Dropbox)

واجهات برمجة التطبيقات للتطبيقات

• قائمة وإنشاء التطبيقات

واجهات برمجة التطبيقات للمعرفة العامة

• قائمة وإنشاء عناصر المعرفة العامة

واجهات برمجة التطبيقات للفريق

• إدارة الفريق

• أعضاء الفريق

• أذونات قائمة على الدور

لأنماط تكامل المؤسسات، واعتبارات الأمان، وأفضل الممارسات المعمارية، راجع دليل أنماط تكامل المؤسسات.

عنوان URL الأساسي

جميع نقاط نهاية واجهة برمجة التطبيقات نسبية لـ:

https://api.rememberizer.ai/api/v1/

المصادقة

تتطلب نقاط النهاية المصادقة باستخدام إما:

• رمز JWT (يتم تمريره في رأس Authorization أو الكوكيز)

• مفتاح API (يتم تمريره في رأس x-api-key)

للحصول على معلومات مفصلة حول نقاط النهاية المحددة، يرجى الرجوع إلى صفحات توثيق API الفردية.