Motimate: كيفية إنشاء التقارير باستخدام واجهة برمجة التطبيقات العامة

بالإضافة إلى مشاركة بيانات إكمال الدورة التدريبية عبر Motimate xAPIفإننا ندعم أيضًا استخراج ملفات Excel من واجهة برمجة تطبيقات Motimate العامة. تستند تقارير Excel هذه على قوالب التقارير التي تم إنشاؤها مسبقًا في إنشاء التقارير ضمن ميزة Insights في Motimate.

إليك بعض المعلومات المفيدة قبل أن نبدأ:

وظائف واجهة برمجة تطبيقات Motimate العامة الثلاث ذات الصلة هي:

• احصل على /إنينسايتس/التعلم/التقارير/قوالب التقارير
   
• مشاركة /أفكار/تعليمات/طلبات_تقارير/طلبات_التقارير
   
• احصل على /insights/learnings/report_requests/{id}

قبل إنشاء تقرير باستخدام واجهة برمجة التطبيقات العامة، تأكد من إنشاء قالب تقرير بالفعل في "إنشاء التقارير"(انظر الدليل هنا)، وأنك تعرف القالب (القوالب) الذي ستنشئ منه التقرير (التقارير). شريطة أن يكون ذلك جاهزًا، ستتطلب عملية إنشاء التقرير ثلاث خطوات:

الخطوة 1: احصل على قائمة بقوالب التقارير:

الأمر: GET /ININSights/learnings/report_templates

مثال على الاستجابة:

{
  "البيانات": [
    {
      **"id": "abc86b82-029a-4b74-9690-4ab607f3eafe"**،
      "الاسم": "اختبار التقرير"،
      "الوصف": "اختبار لغرض واجهة برمجة التطبيقات العامة"،
      "آخر_حالة": "تم التحميل"،
      "Last_generated_at": فارغة،
      "تم الإنشاء_at": "2022-03-01T15:36:42:42.99789+01:00"،
      "تم التحديث_آت": "2022-03-01T15:41:26.98349+01:00",
      "user": {
        "الاسم": "John Doe"
      }
    }
  ]
}

قم بتدوين معرف القالب الذي ستحتاج إلى استخدامه في الخطوة التالية، في هذه الحالة: abc86b82-029a-4b74-9690-4ab607f3eafe

الخطوة 2: إنشاء تقرير جديد استناداً إلى القالب المحدد

الأمر: POST /insights/insights/learnings/report_requests

في هذا المثال، تأكد من إرسال abc86b82-029a-4b74-9690-4ab607f3eafe كقالب_id في هذا الطلب.

مثال على الاستجابة:

{
  "البيانات": {
    **"id": "abc23922-940d-940d-4d6d6d-a6f0-ecaed0081010c4"**،
    "الحالة": "بدأت"،
    "تم الإنشاء_في": "2022-03-03-03T08:48:46.051.051Z"،
    "تم التحديث_في": "2022-03-03-03T08:48:46.051.051Z"،
    "عنوان url": فارغ،
    "قالب": {
      "id": "abc86b82-029a-4b74-9690-4ab607f3eafe",
      "name": "اختبار التقرير"،
      "الوصف": "اختبار لغرض واجهة برمجة التطبيقات العامة"،
      "تم الإنشاء_في": "2022-03-01T15:36:42:42.99789+01:00",
      "updated_at": "2022-03-03T09:48:46.06885+01:00"
    }
  }
}

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

الخطوة 3: الحصول على عنوان URL لملف تقرير Excel

الأمر: GET /insights/insights/learnings/report_requests/{id}

تأكد من استخدام معرف البيانات في الاستجابة من الخطوة 2، وليس معرف القالب!

مثال على الاستجابة:

{
  "البيانات": {
    "id": "abc23922-940d-940d-4d6d6d-a6f0-ecaed0081010c4",
    "status": "تم"،
    "تم الإنشاء_في": "2022-03-03-03T08:48:46.051.051Z"،
    "تم التحديث_في": "2022-03-03-03T08:48:46.839Z",
    **"url": "<https://motimate-reports-production.s3.eu-west-1.amazonaws.com/abc883af5017bcb49a6b99e71b01a0660b8f5204/report-test_1646297326.xlsx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ABCAYLEQ6WVKO52OZP5X%2F20220303%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=22020303T085426Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=abc3806250e855b83fc121ea181764cc6df64481c63371004a27229acbaf98de>"**,
    "قالب": {
      "معرف": "abc86b82-029a-4b74-9690-4ab607f3eafe",
      "name": "اختبار التقرير"،
      "الوصف": "اختبار لغرض واجهة برمجة التطبيقات العامة"،
      "تم الإنشاء_في": "2022-03-01T15:36:42:42.99789+01:00",
      "updated_at": "2022-03-03T09:48:46.70689+01:00"
    }
  }
}

قد تحتاج إلى تشغيل هذا الطلب على أساس متكرر كل 30 ثانية حتى تحصل على استجابة تتضمن قيمة لـ url. يعتمد الوقت الذي يستغرقه ذلك على مقدار البيانات المطلوبة لإنشاء التقرير.

في هذا المثال عنوان url هو https://motimate-reports-production.s3.eu-west-1.amazonaws.com/abc883af5017bcb49a6b99e71b01a0660b8f5204/report-test_1646297326.xlsx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ABCAYLEQ6WVKO52OZP5X%2F20220303%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=22020303T085426Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=abc3806250e855b83fc121ea181764cc6df64481c63371004a27229acbaf98de

سيؤدي الوصول إلى عنوان URL هذا إلى تنزيل تقاريرك في ملف .xlxs Excel . لا يمكن حاليًا استخراج البيانات بأي تنسيقات ملفات أخرى، مثل .csv على سبيل المثال.

يرجى ملاحظة: ستنتهي صلاحية الملف بعد 10 دقائق، ويجب تنزيله قبل ذلك.

ℹ️ إذا تم إنشاء قالب تقرير من قبل مسؤول المجموعة، الذي لديه حق وصول محدود فقط إلى البيانات الخاصة بالمجموعات والمستخدمين المحددين، فسيظل هذا القيد ساري المفعول عند استخدام واجهة برمجة التطبيقات العامة Motimate Public API.