دليل التضمين

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

تدير التضمين من تبويب التضمين ومفاتيح API ضمن مجموعة التخصيص في إعدادات مساحة العمل. ولا يستطيع إنشاء مفاتيح API وإعداد التضمين إلا المالك والمسؤولون.

طريقة العمل

يمر التضمين بأربع خطوات. ويفتح زر الدليل في قسم لوحات البيانات المضمّنة صفحة دليل التكامل، وفيها شرح كل خطوة بأمثلة في Python وNode.js.

1. إعداد لوحة البيانات للتضمين

1. افتح لوحة البيانات واختر تضمين من قائمتها.
2. في خطوة قفل الفلاتر، اختر الأعمدة التي تفصل بيانات كل عميل عن بيانات غيره، مثل tenant_id. يفرض كيوبت هذه الفلاتر المقفلة من جهة الخادم، ولا يستطيع المتصفح تغييرها.
3. في خطوة كود التضمين، انسخ معرّف التضمين.

2. إنشاء مفتاح API

1. في تبويب التضمين ومفاتيح API، ضمن قسم مفاتيح API، أدخل الاسم وأضف الوصف إن شئت.
2. انقر إنشاء مفتاح.
3. انسخ السر فورًا، إذ لا يعرضه كيوبت إلا مرة واحدة. فإن فقدته، فألغِ المفتاح وأنشئ مفتاحًا جديدًا.

ويمكنك أيضًا إنشاء مفتاح من خطوة مفتاح API في نافذة تضمين لوحة البيانات.

يُسمح لكل مساحة عمل بمفتاحين نشطين على الأكثر. ولإنشاء مفتاح آخر، انقر إلغاء المفتاح على أحدهما. وتعرض قائمة المفاتيح لكل مفتاح الاسم والبادئة والحالة وتاريخ الإنشاء وآخر استخدام.

3. إنشاء الرموز في خادمك

حين يفتح المستخدم صفحةً فيها لوحة البيانات المضمّنة، ينشئ خادمك له رمزًا قصير الأجل. والرمز من نوع JWT يُوقَّع بخوارزمية HS256 بسر المفتاح، ويتضمن:

• الحقل kid في الترويسة: معرّف مفتاح API.
• embed_id: معرّف التضمين من الخطوة 1.
• tenant: قيمة لكل فلتر مقفل، مثل معرّف شركة المستخدم. فإن نقصت قيمة، رفض كيوبت الطلب.
• jti: معرّف فريد، ولا يُستخدم كل رمز إلا مرة واحدة.
• exp: وقت انتهاء الصلاحية، ولا يتجاوز 15 دقيقة من وقت الإنشاء.

4. عرض لوحة البيانات في واجهة تطبيقك

1. حمّل البرنامج النصي embed.js من عنوان API لكيوبت الذي تستخدمه، ويعرض دليل التكامل العنوان بدقة.
2. أضف العنصر <qubit-dashboard> حيث تريد أن تظهر اللوحة.
3. اطلب رمزًا من خادمك، ثم عيّنه قيمةً للخاصية token في العنصر. وتُحمَّل اللوحة متى حصلت على رمز صالح.

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

ويمكنك مواءمة مظهر اللوحة مع تطبيقك بخصائص العنصر، مثل theme وaccent-color وfont-family. ويسردها قسم السمات في دليل التكامل جميعًا.

قائمة لوحات البيانات المضمّنة

يسرد قسم لوحات البيانات المضمّنة لوحات هذه المساحة المُعدّة للتضمين، مبيّنًا لكل منها الفلاتر المقفلة والحالة وتاريخ الإنشاء ونشاط المستأجرين.