نقطة النهاية ومرجع الاستجابة
POST/api/shop/sessionالنعناع — حامل السر (Bearer)
DELETE/api/shop/session/:tokenإبطال - سر حامل (Bearer)
في هذا العرض التوضيحي، يتم تنفيذ عملية سك العملة عبر الوكيل في المسارات المذكورة أعلاه. في الإنتاج، يتم سك الجلسة في قلب ADITUS — العقد مطابق. كلا الاستدعاءين من خادم إلى خادم: تتم مصادقة الواجهة الخلفية الخاصة بك باستخدام سر النعناع الخاص بعميلك (الذي تم إنشاؤه في وحدة تحكم مسؤول ADITUS) كرمز مميز لحاملها. نعناع واحد لكل تسجيل دخول هو النمط العادي؛ الرمز المميز الناتج هو كل ما يراه المتصفح على الإطلاق. (Bearer)
يمكنك تجربة هذا التدفق الدقيق باستخدام بيانات الاعتماد الخاصة بك فياختبار التكامل— النعناع، جبل، المشي في الرحلة.
سك جلسة - طلب
رأسقيمةمعنى
AuthorizationBearer <mint-secret>سر النعناع الخاص بعميلك، والذي تم إنشاؤه في وحدة تحكم المشرف الخاصة بـ ADITUS. من جانب الخادم فقط - يجب ألا يتم شحنه مطلقًا إلى متصفح أو حزمة تطبيقات.
Content-Typeapplication/jsonالجسم هو كائن JSON.
مجال الجسميكتبمعنى
publicKeystring · requiredالمفتاح القابل للنشر الذي تم سك الجلسة من أجله. يجب أن يكون هو نفس المفتاح الذي يتم تركيب الواجهة الأمامية الصغيرة به - يتم التحقق من كل مكالمة متجر لاحقة (403 عند عدم التطابق). يجب أن ينتمي سر حامل هذا المفتاح إلى عميل هذا المفتاح. (Bearer)
emailstring · optionalمستخدم المتجر الذي تعمل فيه الجلسة. يمكنك الحصول عليها من جلسة خادمك المصادق عليها (تسجيل الدخول/ملف تعريف الارتباط SSO أو JWT) - وليس من طلب المتصفح أبدًا، وإلا يمكن للزائر الحصول على جلسة شخص آخر. قم بحذفها لإنشاء جلسة مجهولة: يمكن للزائر تصفح عربة التسوق وملؤها، لكن الواجهة الأمامية الصغيرة تحظر الخطوة التي تلي عربة التسوق حتى يوفر رد الاتصال onUserRequired جلسة مرتبطة بالمستخدم (راجع تدفق المستخدم الاختياري). لا يزال يتم رفض البريد الإلكتروني الحالي ولكن المشوه (400).
externalUserIdstring · optionalمعرف المستخدم الخاص بك، المُخزن مع الجلسة كبيانات وصفية (مفيد للدعم وارتباط السجل). لم يتم تفسيره بواسطة ADITUS.
ttlSecondsnumber · optionalمدة الجلسة بالثواني. الافتراضي 20 دقيقة، بحد أقصى 24 ساعة. عند انتهاء صلاحيتها، تُرجع مكالمات المتجر 401 session_expired — ثم قم بصك رمز مميز جديد (على سبيل المثال عبر الخطاف onSessionExpired).
eventSlugstring · optionalيعمل على إصلاح جانب خادم ENTRY POINT الخاص بالرحلة: تعيين، تبدأ الواجهة الأمامية الصغيرة مباشرة عند تحديد مقالة هذا الحدث؛ تم حذفه، فهو يبدأ في نظرة عامة على الحدث. نظرًا لأنه جزء من الجلسة المسكوكة، فلا يمكن للمتصفح التعامل معه. الأحرف غير الصالحة تنتج 400 valid_event_slug؛ سبيكة ثابتة لا تحل أي حدث مباشر تعود إلى النظرة العامة على الحدث.
سك جلسة – الرد (200)
مجاليكتبمعنى
sessionTokenstringرمز غير شفاف (sess_...). قم بتسليمها إلى المتصفح وتمريرها إلى mount() كـ sessionToken؛ ترسلها الواجهة الأمامية الصغيرة كجلسة X-Aditus في كل مكالمة متجر. لا يحتوي على بيانات المستخدم ولا يمكن فك تشفيره.
expiresAtnumberانتهاء الصلاحية كطابع زمني لنظام Unix بالمللي ثانية. معلوماتية بحتة لجدولتك الخاصة - تتفاعل الواجهة الأمامية الصغيرة مع 401 من تلقاء نفسها.
إلغاء الجلسة
DELETE /api/shop/session/:token بنفس سر الحامل - يجب أن ينتمي السر إلى العميل الذي تم سك الجلسة من أجله. قم باستدعائه عند تسجيل الخروج حتى يموت الرمز المميز مع جلستك الخاصة. الاستجابة: { "تم إبطاله": صحيح } (أو خطأ إذا كانت الجلسة قد انتهت بالفعل). الإلغاء أمر غير فعال وآمن للحرق والنسيان. (Bearer)
الأخطاء واضحة
حالةشفرةمعنى
503session_not_configuredجلسات التضمين غير مهيأة لهذا العميل.
401unauthorizedقيمة mint secret المستخدمة لإنشاء الجلسة غير صالحة أو مفقودة.
400invalid_public_keyقيمة public key المقدمة غير صالحة.
400invalid_emailعنوان البريد الإلكتروني المقدم غير صالح.
400invalid_tokenقيمة session token المقدمة غير صالحة.
429rate_limitedعدد الطلبات كبير جداً. حاولوا مجدداً بعد قليل.
403public_key_invalidتنسيق public key المقدمة غير صالح.
403public_key_unknownلم يتم التعرف على public key المقدمة.
403public_key_origin_unresolvedتعذر تحديد مصدر هذا الطلب.
403public_key_domain_not_allowedالنطاق الذي صدر منه هذا الطلب غير مسموح له باستخدام public key هذه.
401invalid_sessionالجلسة المقدمة غير صالحة.
401session_expiredانتهت صلاحية الجلسة المقدمة.
403session_requires_public_keyتتطلب هذه الجلسة public key.
403session_key_mismatchلا تتطابق public key مع الجلسة.
403anonymous_sessionهذه العملية غير متاحة لجلسة مجهولة الهوية.