عبر API

تسجيل الدخول المخصص عبر API ممكن فقط عند تمكينه من الخلفية بواسطة Ideanote، يرجى الاتصال بنا إذا كنت ترغب في استخدام طريقة المصادقة هذه.

تصف هذه المقالة كيفية تسجيل دخول المستخدم في المتصفح باستخدام Ideanote API. يمكن استخدام هذه التقنية عندما لا يكون JWT أو SAML أو OpenID خيارًا. لتسجيل دخول المستخدم، يجب عليك اتباع الخطوات التالية:

إنشاء مستخدم أو تحديثه والحصول على رمز جلسة المستخدم.
إنشاء رابط باستخدام رمز الجلسة يمكن استخدامه لتسجيل دخول المستخدم تلقائيًا في المتصفح.

إنشاء أو تحديث المستخدم والحصول على رمز الجلسة.

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

POST https://api.ideanote.io/v1/session?fields=kind,user.id,sessionToken

معلمات الجسم:

الاسم

الوصف

spaceId

معرف مساحة العمل الخاصة بك

kind

يجب أن يتم تعيين هذه القيمة دائمًا إلى: CUSTOM

data

كائن بيانات يصف تفاصيل المستخدم

الاسم	الوصف
email (مطلوب)	البريد الإلكتروني للمستخدم. نحدد ما إذا كان هناك مستخدم موجود بالفعل في مساحة العمل عبر العثور على مستخدم موجود بهذا العنوان البريدي.
apiToken (مطلوب)	رمز API لحساب مالك في مساحة العمل الخاصة بك. يمكن الحصول على رمز API هذا من /settings/profile في تطبيق Ideanote على الويب.
sub	معرف فريد اختياري سيتم استخدامه للعثور على مستخدم موجود في مساحة عمل Ideanote. إذا لم يتم توفير sub، سيتم استخدام البريد الإلكتروني بدلاً منه للعثور على مستخدم موجود.
name	اسم المستخدم
avatarUrl	رابط لصورة يجب استخدامها كصورة رمزية لهذا المستخدم.
team	اسم فريق يجب إضافة المستخدم إليه. سيتم إنشاء الفريق إذا لم يكن موجودًا.
locale	لغة المستخدم

مثال على الطلب:

Bash

 
curl "https://api.ideanote.io/v1/session?fields=kind,user.id,sessionToken" \
  -H "Content-Type: application/json" \
  -d '{
"spaceId": "b06f0a9a-4813-4515-81a0-29e8f2d193ec",
"kind": "CUSTOM",
"data": {
  "email": "john@doe.com",
  "apiToken": "f2dacce1fe557c7f140a3f7e85",
  "name": "John Doe",
  "avatarUrl": "https://avatars.githubusercontent.com/u/1234"
}
}'

مثال على النتيجة:

JSON

 
{  "sessionToken":"41b0d309e0e4a341eccf611f9a70cbb91a6a_164864564232",  "user": ...}

إنشاء رابط تسجيل الدخول باستخدام رمز الجلسة

بعد الحصول على sessionToken للمستخدم، يمكنك إنشاء رابط يمكن استخدامه لتسجيل دخول المستخدم مباشرة في المتصفح.

رابط مباشر إلى تطبيق الويب

https://{{SUBDOMAIN}}.ideanote.io/login/session/{{SESSION_TOKEN}}

مثال:

تلقائي

https://mysubdomain.ideanote.io/login/session/41b0d309e0e4a341eccf611f9a70cbb91a6a_164864564232

رابط مباشر إلى الودجيت

أولاً يجب عليك الحصول على رابط الودجيت. يمكن العثور على هذا بمشاركة مهمة، تحرير كود التضمين والحصول على رابط ودجيت "صفحة كاملة".

بعد ذلك يجب عليك تمديد URL بمعامل الاستعلام: &auth.sessionToken={{SESSION_TOKEN}}.

https://idea-widget.ideanote.io/idea-confirmation?config={{WIDGET_ID}}&auth.sessionToken={{SESSION_TOKEN}}