توفر هذه المستندات تعليمات حول كيفية استخدام واجهة برمجة التطبيقات الجديدة لربط نطاق الترحيل. سيسمح سير العمل هذا بالترحيل من عنوان URL واحد أو أكثر من عناوين URL للارتباط 1.1 إلى نطاق تسجيل 1.3 مختلف، مما يؤدي إلى ملء فجوة متطلبات مطابقة المجال بالضبط.
ما يمكن أن تفعله
ستسمح واجهة برمجة تطبيقات تعيين نطاق الترحيل هذه بالترحيل من عنوان URL واحد أو أكثر من عناوين URL للرابط القديم إلى نطاق تسجيل Advantage مختلف. تتضمن حالات الاستخدام إضافة النطاقات القديمة أو إزالتها أو تحديثها وترحيل عناوين URL متعددة للروابط القديمة إلى نطاق تسجيل ميزة مختلف. بعد اكتمال هذا التعيين، يمكن إكمال عمليات الترحيل من خلال عمليات الترحيل العادية لنسخ المقرر الدراسي أو الاستيراد أو يدويا باستخدام ترحيل زر.
على سبيل المثال، الروابط التي تحتوي على عناوين URL التالية للروابط القديمة:
- Domain1.example.com ، و
- Domain2.example2.com
يمكن ترحيلها إلى نطاق التسجيل التالي:
الجدول 1: أمثلة الترحيل المتاحة من خلال واجهة برمجة تطبيقات ربط نطاق الترحيل.
مثال على حالة مستخدم | عنوان URL للرابط القديم | نطاق تسجيل Advantage | المجال المعين | رابط عنوان URL بعد الترحيل |
---|
تغيير النطاق الفرعي | subdomain1.primary.com/path1 | domain3.com | domain1.com | domain3.com/path1 |
المجال الفرعي | subdomain1.domain2.com/path1 | domain3.com | domain2.com | domain3.com/path1 |
إزالة النطاق الفرعي وتغيير النطاق | domain2.com/path1 | domain3.com | domain2.com | domain3.com/path1 |
تعيين عناوين URL للروابط القديمة المتعددة | domain2.com. subdomain1.domain2.com | domain3.com | domain2.com | domain3.com |
ما لا يمكنه فعله
لا تسمح وظيفة الترحيل الإضافية هذه بتحديث المسار أو تحديث المعلمات المخصصة من خلال عملية الترحيل. كما هو موضح في الجدول أعلاه، يتم نقل المسار من عنوان URL للرابط القديم إلى عنوان URL للرابط بعد الترحيل. تملأ واجهة برمجة التطبيقات الإضافية هذه فقط فجوة مطابقة المجال بالضبط. جميع القيود الأخرى وحالات الاستخدام الموضحة في وثائق ترحيل LTIو الأسئلة الشائعة حول الترحيل لا يزال ينطبق.
واجهة برمجة تطبيقات الترحيل (الذي ينقل رابطا واحدا في كل مرة) لا يعمل مع النطاقات القديمة المعينة.
كيف يعمل
يمكن العثور على عنوان URL للرابط القديم على مستوى المقرر الدراسي. انتقل إلى مسؤول الدورة >أدوات التعلم الخارجية > إدارة روابط الأدوات (القديمة) وحدد الرابط الخاص بك.
الشكل: مثال على عنوان URL للرابط القديم LTI 1.1.
لعرض مجال تسجيل الميزة، انتقل إلى أدوات المسؤول > إدارة قابلية التوسعة > ميزة LTI وحدد تسجيلك.
شكل: مثال على نطاق تسجيل ميزة LTI 1.3 في نطاق تحرير أداة اختبار LTI حوار.
تتم محاولة الترحيل فقط عند مشاركة عمليات النشر. قد تحتاج إلى التحقق من قواعد المشاركة للنشر. يجب على العميل توفير السياق الصحيح للمكان الذي يلزم فيه الترحيل.
من ميزة LTI علامة التبويب ، انقر فوق تسجيل أداة Advantage، وانتقل إلى عرض عمليات النشر.
حدد النشر الخاص بك، وتأكد من مشاركته مع وجهة الترحيل عن طريق إضافة وحدات تنظيمية في إتاحة الأداة ل قسم. ترحيل الروابط تلقائيا يجب تمكينها.
الشكل: ال إتاحة الأداة ل قسم
يمكن العثور على عنوان URL للرابط بعد الترحيل على مستوى المقرر الدراسي. انتقل إلى مسؤول الدورة > أدوات التعلم الخارجية > ميزة LTI وحدد الرابط الخاص بك.
الشكل: ال تحرير رابط AGS مع التواريخ مربع الحوار حيث يمكنك تحديد موقع عنوان URL للارتباط بعد الترحيل.
بعد تعيين المجالات القديمة، يمكن إكمال عمليات الترحيل من خلال عمليات الترحيل الحالية لنسخ المقرر الدراسي أو استيراده أو يدويا باستخدام السمة ترحيل على مستوى المقرر الدراسي إدارة روابط الأدوات (القديمة) صفحة.
خطوات التنفيذ
1. تأكد مما إذا كانت مطابقة المجال الدقيقة هي القيد الوحيد. لا يمكن تحديث المسار وأي معلمات مخصصة. ال إدارة تسجيلات أداة LTI Advantage الإذن مطلوب.
2. باستخدام Postman أو أي أداة اختبار API أخرى ، استخدم واجهة برمجة تطبيقات GET للعثور على جميع التسجيلات للمثيل. ثم انسخ ClientID لمجال تسجيل Advantage المطلوب الذي تم حظره مسبقا بواسطة متطلبات مطابقة المجال الدقيقة. هذا هو مجال تسجيل LTI Advantage.
الحصول على / d2l / api / le / (الإصدار) / ltiadvantage / التسجيل /
<br/>
3. استخدم واجهة برمجة تطبيقات Mapping Get الجديدة للحصول على التسجيلات المتوفرة ل ClientId هذا:
GET/d2l/api/le/{version}/ltiadvantage/registration/{clientId}/legacydomains/
تقوم واجهة برمجة التطبيقات هذه بإرجاع مصفوفة JSON من سلاسل المجال القديمة التي تم تكوينها لتسجيل ميزة LTI معين. يجب أن يعرض هذا الطلب الأولي نتيجة فارغة.
4. لتعيين عنوان URL للرابط القديم إلى نطاق تسجيل Advantage، استخدم واجهة برمجة تطبيقات POST. هذا هو عمود عنوان URL للرابط القديم الذي تم حظره سابقا بسبب قيود مطابقة النطاق الدقيقة، لاحظ أن https:// مطلوب. يمكن تشغيل واجهة برمجة التطبيقات هذه عدة مرات لإضافتها إلى القائمة الحالية.
POST/d2l/api/le/{version}/ltiadvantage/registration/{clientId}/legacydomains/
الشكل: استخدم واجهة برمجة تطبيقات POST لتعيين عنوان URL للارتباط القديم إلى مجال تسجيل Advantage.
5. لتعيين أكثر من عنوان URL واحد للرابط القديم إلى تسجيل 1.3، استخدم واجهة برمجة تطبيقات PUT. تحل واجهة برمجة تطبيقات PUT محل القائمة الحالية لعناوين URL المعينة.
PUT/d2l/api/le/{version}/ltiadvantage/registration/{clientId}/legacydomains/
الشكل: استخدم واجهة برمجة تطبيقات PUT لتعيين عنوان URL متعدد للارتباط القديم إلى تسجيل 1.3.
تحاول جميع أحداث الترحيل المستقبلية الآن الترحيل من عناوين URL للروابط القديمة التي تم تعيينها إلى تسجيل النطاق 1.3. يمكن بدء الترحيل عن طريق واجهة برمجة التطبيقات أو نسخ المقرر الدراسي أو الاستيراد أو يدويا على مستوى المقرر الدراسي.
يحتوي عنوان URL للرابط بعد الترحيل المسمى على مسار عنوان URL للرابط القديم.
يتم تحديد مهام الترحيل الفاشلة في جدول سجل الترحيل مع الإدخالات في لا يوجد تطابق للنطاق عمود.
الشكل: ال لا يوجد تطابق للنطاق يشير إلى ما إذا كان هناك أي فشل في مهام الترحيل بسبب مشكلات المطابقة.
كيفية إيقاف واجهة برمجة تطبيقات ربط نطاق الترحيل
لإيقاف هذه العملية، اطلب واجهة برمجة تطبيقات PUT بسلسلة فارغة، وسيؤدي ذلك إلى إزالة المجالات القديمة التي تم تعيينها مسبقا.
لإيقاف عملية الترحيل على الفور، قم بتعطيل ترحيل الروابط تلقائيا قم بالتبديل عند النشر أو إزالة أي قواعد مشاركة حيث لا يكون الترحيل مطلوبا. يمكن تعطيل التكامل في أي وقت أيضا ، ولكن هذا يوقف أيضا التكامل بأكمله من العمل ، بدلا من مجرد الترحيل.