Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Content imported from a Scroll Translations translation file.

...

Sv translation
languagear


يتيح لك خادم MagicINFO Server تنفيذ إدارة المحتوى وإدارة الجدول وإدارة الجهاز وغيرها من الوظائف الأخرى باستدعاء واجهة برمجة التطبيقات المفتوحة (الإصدار 2.0). 

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

التصديق

عند استدعاء جميع عناصر واجهة برمجة التطبيقات المفتوحة (الإصدار 2.0)، يجب تضمين api_token في العنوان الرئيس. وفي حالة عدم تضمينه، سيؤدي ذلك إلى ظهور الخطأ "‎401 Unauthorized". 

تنتهي صلاحية الرمز المميّز المحصول عليه ويصبح غير متاح للاستخدام بعد فترة زمنية معينة. وفي هذه الحالة، يجب عليك الحصول على رمز مميّز جديد.

يمكن الحصول على api_token باستدعاء واجهة برمجة التطبيقات.

اسم الخدمة

استدعاء API

نوع الاستدعاءالوصف
طلب المصادقة

/auth

نشراستيراد قيمة الرمز المميّز للمصادقة باستخدام هوية المستخدم وكلمة المرور.
طلب المصادقة

/auth/refresh

الحصولإنشاء رمز مميّز جديد لتمديد وقت انتهاء الصلاحية. من الممكن استدعاء REST API دون تسجيل الدخول مرّة أخرى.

واجهة برمجة التطبيقات المفتوحة (الإصدار 2.0)

توفر واجهة برمجة التطبيقات المفتوحة (الإصدار 2.0) لخادم MagicINFO Server العديد من الوظائف المختلفة. ونستعرض فيما يلي تكوين كل وظيفة من الوظائف. 

الفئةعنصر التحكّمالوصف
المحتوى.content-controllerإدارة ملف المحتوى
content-group-controllerإدارة مجموعة المحتوى
قائمة التشغيلplaylist-controllerإدارة قوائم التشغيل
playlist-group-controllerإدارة مجموعة قوائم التشغيل
جدولcontent-schedule-controllerإدارة جدول المحتوى
content-schedule-group-controllerإدارة مجموعة جدول المحتوى
message-schedule-controllerإدارة جداول الرسائل
message-schedule-group-controllerإدارة مجموعة جداول الرسائل
الجهازdevice-controllerإدارة الجهاز
device-group-controllerإدارة مجموعة الأجهزة
المستخدمuser-controllerإدارة المستخدمين
user-group-controllerإدارة مجموعة المستخدمين
الضبطenvironment-controllerالضبط

المحتوى.

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

فيما يلي خدمات إدارة المحتوى المتاحة:

اسم الخدمة

استدعاء API

نوع الاستدعاءالوصف
listAllContent

/restapi/v1.0/cms/contents

الحصولاستيراد قائمة بالمحتوى الذي تم تحميله. تكون الصور المصغرة للمحتوى والأسماء وأنواع الملفات وغيرها من المعلومات الأساسية الأخرى متضمنة في القائمة. يمكن استيراد القوائم لكل صفحة باستخدام معلومات الترحيل.
listDashboardContentInfo

/restapi/v1.0/cms/contents/dashboard

الحصولاستيراد معلومات المحتوى العامة ليتم عرضها على لوحة المعلومات.
listContent

/restapi/v1.0/cms/contents/filter

نشراستيراد قائمة بالمحتوى المرشّح اعتمادًا على الحالات. يمكن استيراد القوائم لكل صفحة باستخدام معلومات الترحيل.
forceDeleteContent

/restapi/v1.0/cms/contents/force/{contentId}

حذفحذف المحتوى سواء كان المحتوى متضمنًا في قائمة تشغيل أو جدول أم لا.
deleteContent

/restapi/v1.0/cms/contents/{contentId}

حذفحذف المحتوى بعد التحقّق من أنه غير متضمن في قائمة تشغيل أو جدول. إذا كنت تحاول حذف محتوى متضمن في قائمة تشغيل أو جدول، فلن يتم حذف المحتوى وسيظهر رمز خطأ.
getActiveContentInfo

/restapi/v1.0/cms/contents/{contentId}

الحصولاستيراد تفاصيل إصدار منشَّط من المحتوى. يتم تحديث إصدار المحتوى في كل مرة يتم خلالها تحرير المحتوى.
approveContents

/restapi/v1.0/cms/contents/{contentId}/approval

وضعاعتماد/رفض المحتوى. يتم نقل المحتوى المعتمد إلى قائمة المحتوى العام ويمكن استخدامه في قوائم التشغيل أو الجداول.
uploadContent

/restapi/v1.0/cms/contents/{groupId}

نشرتحميل محتوى جديد.

listDefaultGroup

/restapi/v1.0/cms/contents/groups

الحصولاستيراد قائمة مجموعات المحتوى الافتراضي.
getGroup

/restapi/v1.0/cms/contents/groups/{groupId}

الحصولاستيراد تفاصيل المجموعة {groupId}.
listChildGroup

/restapi/v1.0/cms/contents/groups/{groupId}/child

الحصولاستيراد قائمة المجموعات الفرعية تحت المجموعة {groupId}.


قائمة التشغيل

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

فيما يلي خدمات إدارة قوائم التشغيل المتاحة:

اسم الخدمة

استدعاء API

نوع الاستدعاءالوصف
listAllPlaylist

/restapi/v1.0/cms/playlists

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

/restapi/v1.0/cms/playlists

نشرإنشاء قائمة تشغيل جديدة.

getDashboardPlaylistInfo

/restapi/v1.0/cms/playlists/dashboard

الحصولاستيراد معلومات قوائم التشغيل الضرورية من لوحة المعلومات.

listPlaylist

/restapi/v1.0/cms/playlists/filter

نشراستيراد قائمة بقوائم التشغيل المرشّحة اعتمادًا على الحالات. يمكن استيراد القوائم لكل صفحة باستخدام معلومات الترحيل.

deletePlaylist

/restapi/v1.0/cms/playlists/{playlistId}

حذفحذف قائمة التشغيل المحدّدة. إذا كنت تحاول حذف قائمة تشغيل متضمنة في جدول، فلن يتم حذف قائمة التشغيل وسيظهر رمز خطأ.

getActivePlaylistInfo

/restapi/v1.0/cms/playlists/{playlistId}

الحصولاستيراد تفاصيل إصدار منشَّط من قائمة التشغيل. يتم تحديث إصدار قائمة التشغيل في كل مرة يتم خلالها تحرير قائمة التشغيل.

editPlaylist

/restapi/v1.0/cms/playlists/{playlistId}

وضعتحرير قائمة التشغيل {playlistId}. يعمل تحرير قائمة تشغيل على تحديث إصدار قائمة التشغيل، ويتسبب في تشغيل الجهاز الذي يشغّل قائمة التشغيل لقائمة التشغيل المحدّثة تلقائيًا.

copyPlaylist

/restapi/v1.0/cms/playlists/{playlistId}/copy

وضعنسخ قائمة التشغيل {playlistId}. يتم إنشاء نسخة مكرّرة من قائمة التشغيل.
listDefaultGroup

/restapi/v1.0/cms/playlists/groups

الحصولاستيراد قائمة مجموعات قوائم التشغيل الافتراضية.

getGroup

/restapi/v1.0/cms/playlists/groups/{groupId}

الحصولاستيراد تفاصيل المجموعة {groupId}.
listChildGroup/restapi/v1.0/cms/playlists/groups/{groupId}/childالحصول

استيراد قائمة المجموعات الفرعية تحت المجموعة {groupId}.

جدول

إنشاء جداول رسائل أو محتوى جديدة. نشر الجداول للأجهزة للتشغيل. تحرير الجداول أو حذفها.

يمكن للمستخدمين المصادقين من ذوي الامتيازات الخاصّة بقراءة الجداول وكتابته وإدارته الوصول إلى الخدمات المرتبطة بالجدول.

فيما يلي خدمات إدارة الجدول المتاحة:

اسم الخدمة

استدعاء API

نوع الاستدعاءالوصف
listContentScheduleAll

/restapi/v1.0/dms/schedule/contents

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

/restapi/v1.0/dms/schedule/contents

نشرإنشاء جدول محتوى جديد. يمكن أن يحتوي جدول المحتوى على العديد من القنوات والإطارات. نشر جدول للأجهزة وتشغيل المحتوى المطلوب أو قائمة التشغيل في وقت محدّد.
listDashboardScheduleInfo

/restapi/v1.0/dms/schedule/contents/dashboard

الحصولاستيراد معلومات جدول المحتوى الضرورية من لوحة المعلومات.
listContentScheduleByGroup

/restapi/v1.0/dms/schedule/contents/filter

نشراستيراد قائمة بجداول المحتوى المرشّحة اعتمادًا على الحالات المختلفة. يمكن استيراد القوائم لكل صفحة باستخدام معلومات الترحيل.
deleteContentSchedule

/restapi/v1.0/dms/schedule/contents/{programId}

حذفحذف جدول محتوى. في حالة حذف جدول منشور مسبقًا في جهاز، يشغل الجهاز تلقائيًا المحتوى الافتراضي.
getProgramInfo

/restapi/v1.0/dms/schedule/contents/{programId}

الحصولاستيراد تفاصيل الجدول المحدد.
editContentSchedule

/restapi/v1.0/dms/schedule/contents/{programId}

وضعتحرير جدول محتوى. في حالة تحرير جدول منشور مسبقًا في جهاز، يشغل الجهاز تلقائيًا الجدول الذي تم تحريره.
copyContentSchedule

/restapi/v1.0/dms/schedule/contents/{programId}/copy

وضعنسخ جدول المحتوى {programId}. يتم إنشاء نسخة مكرّرة من جدول المحتوى {programId}.
deployContentSchedule

/restapi/v1.0/dms/schedule/contents/{programId}/deploy

وضعنشر جدول محتوى في مجموعة جهاز محدّدة.
getPublishStatus

/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus

الحصولاستيراد حالة تنزيل جدول المحتوى في الوقت الحقيقي من جهاز.
getRootGroups

/restapi/v1.0/dms/schedule/contents/groups

الحصولاستيراد قائمة مجموعات الجذر لجدول محتوى.
listContentScheduleGroupInfo/restapi/v1.0/dms/schedule/contents/groups/{groupId}الحصولاستيراد تفاصيل المجموعة {groupId}.
listAllMessageSchedule

/restapi/v1.0/dms/schedule/messages

الحصولاستيراد قائمة جميع جداول الرسائل.
createMessageSchedule

/restapi/v1.0/dms/schedule/messages

نشرإنشاء جدول رسالة جديد.
إدراج الرسالة

/restapi/v1.0/dms/schedule/messages/filter

نشر 

استيراد قائمة بجداول الرسائل المرشّحة اعتمادًا على الحالات المختلفة. يمكن استيراد القوائم لكل صفحة باستخدام معلومات الترحيل.
deleteMessageSchedule

/restapi/v1.0/dms/schedule/messages/{messageId}

حذفحذف جدول الرسائل المحدّد. في حالة حذف جدول رسائل منشور مسبقًا في جهاز، ينطبق التغيير تلقائيًا على الجهاز.
getMessageInfo

/restapi/v1.0/dms/schedule/messages/{messageId}

الحصولاستيراد تفاصيل جدول الرسائل المحدد.
editMessageSchedule

/restapi/v1.0/dms/schedule/messages/{messageId}

وضعتحرير جدول الرسائل المحدّد. في حالة تحرير جدول رسائل منشور مسبقًا في جهاز، ينطبق التغيير تلقائيًا على الجهاز.
copyMessageSchedule

/restapi/v1.0/dms/schedule/messages/{messageId}/copy

وضعنسخ جدول الرسائل المحدّد. يتم إنشاء نسخة مكرّرة من جدول الرسائل.
deployMessageSchedule

/restapi/v1.0/dms/schedule/messages/{messageId}/deploy

وضعنشر جدول الرسائل المحدّد على مجموعة جهاز.
getRootGroups

/restapi/v1.0/dms/schedule/messages/groups

الحصولاستيراد قائمة مجموعات الجذر لجدول محتوى.
listMessageScheduleGroupInfo

/restapi/v1.0/dms/schedule/messages/groups/{groupId}

الحصولاستيراد تفاصيل المجموعة {groupId}.
getChildGroups

/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child

الحصولاستيراد قائمة المجموعات الفرعية تحت المجموعة المحددة.

الجهاز

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

فيما يلي خدمات إدارة الأجهزة المتاحة:

اسم الخدمة

استدعاء API

نوع الاستدعاءالوصف
listAllDevice

/restapi/v1.0/rms/devices

الحصولاستيراد قائمة بجميع الأجهزة. تكون حالة طاقة الجهاز ومعلومات الصورة المصغرة وحالة خطأ الجهاز وغيرها من المعلومات الأساسية الأخرى متضمنة في القائمة. يمكن استيراد القوائم لكل صفحة باستخدام معلومات الترحيل.
getDashboardDeviceInfo

/restapi/v1.0/rms/devices/dashboard

الحصولاستيراد معلومات الأجهزة الضرورية من لوحة المعلومات.
filterDeviceList

/restapi/v1.0/rms/devices/filter

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

/restapi/v1.0/rms/devices/{deviceId}

حذفحذف الجهاز المحدّد.
getDevice

/restapi/v1.0/rms/devices/{deviceId}

الحصولاستيراد تفاصيل الجهاز المحدد.
approveDevice

/restapi/v1.0/rms/devices/{deviceId}/approval

وضعاعتماد الجهاز المحدّد لمجموعة محددة.
getCabinetList

/restapi/v1.0/rms/devices/{deviceId}/cabinet

نشراستيراد معلومات حول الخزائن المتصلة بجهاز LED. تكون المعلومات المستوردة صالحة فقط عند اتصال الخزائن بجهاز LED.
updateCabinetInfo

/restapi/v1.0/rms/devices/{deviceId}/cabinet

وضعتحرير معلومات حول الخزائن المتصلة بجهاز LED.
getDisplayControlInfo

/restapi/v1.0/rms/devices/{deviceId}/display

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

/restapi/v1.0/rms/devices/{deviceId}/display

وضعإرسال معلومات التحكّم في العرض إلى جهاز. يقتصر الإرسال على القيم التي تم تحريرها ضمن معلومات العرض فقط وتُرسل في صورة بروتوكول إلى الجهاز.
getUpdatedDisplayInfoResult

/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}

الحصولتلقّي معلومات التحكّم في العرض التي تم تحريرها من جهاز. تكون واجهة برمجة التطبيقات هذه قابلة للتنفيذ بعد تنفيذ خدمة تحديث معلومات العرض.
getGeneralInfo

/restapi/v1.0/rms/devices/{deviceId}/general

الحصولاستيراد معلومات الأجهزة العامة من قاعدة البيانات. يتم تحديث معلومات الأجهزة العامة عند اتصال الجهاز بالخادم.
updateGeneralInfo

/restapi/v1.0/rms/devices/{deviceId}/general/info

وضعإرسال معلومات الجهاز التي تم تحريرها إلى جهاز. يقتصر الإرسال على القيم التي تم تحريرها ضمن معلومات الجهاز الأساسية فقط وتُرسل في صورة بروتوكول إلى الجهاز.
getUpdatedGeneralInfoResult

/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}

الحصولتلقّي معلومات الجهاز التي تم تحريرها من جهاز. تكون واجهة برمجة التطبيقات هذه قابلة للتنفيذ بعد تنفيذ خدمة تحديث المعلومات العامة.
moveDevice

/restapi/v1.0/rms/devices/{deviceId}/move

وضعنقل جهاز إلى مجموعة أخرى.
startRmServerVnc

/restapi/v1.0/rms/devices/{deviceId}/rmserver/start

الحصولإرسال بروتوكول بدء وضع إعادة التعيين إلى جهاز. يرسل جهاز تلقّى بروتوكول بدء وضع إعادة التعيين معلومات دوريّة عبر خادم جهاز التحكم عن بعد.
stopRmServerVnc

/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop

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

/restapi/v1.0/rms/devices/{deviceId}/setup

الحصولاستيراد إعدادات الجهاز. يتم تحديث إعدادات الجهاز عند اتصال الجهاز بالخادم.
updateSetupInfo

/restapi/v1.0/rms/devices/{deviceId}/setup

وضعإرسال إعدادات الجهاز التي تم تحريرها إلى جهاز. يقتصر الإرسال على القيم التي تم تحريرها في الإعدادات فقط وتُرسل في صورة بروتوكول إلى الجهاز.
getUpdatedSetupInfoResult

/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}

الحصولتلقّإعدادات معلومات الجهاز التي تم تحريرها من جهاز. تكون واجهة برمجة التطبيقات هذه قابلة للتنفيذ بعد تنفيذ خدمة تحديث معلومات الإعداد.
getCurrentStatusDisplay

/restapi/v1.0/rms/devices/{deviceId}/status/display

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

/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}

الحصولاستيراد معلومات التحكّم في العرض المُرسلة من جهاز. يُستخدم هذا الخيار لإجراءين اثنين: إرسال طلب الحصول على معلومات إلى جهاز وتلقّي معلومات الجهاز الفعلية.
getCurrentStatusTime

/restapi/v1.0/rms/devices/{deviceId}/status/time

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

/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}

الحصولاستيراد معلومات الوقت المُرسلة من جهاز. يُستخدم هذا الخيار لإجراءين اثنين: إرسال طلب الحصول على معلومات إلى جهاز وتلقّي معلومات الجهاز الفعلية.
getTimeInfo

/restapi/v1.0/rms/devices/{deviceId}/time

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

/restapi/v1.0/rms/devices/{deviceId}/time

وضعإرسال معلومات الوقت التي تم تحريرها إلى جهاز. يقتصر الإرسال على القيم التي تم تحريرها ضمن معلومات الوقت فقط وتُرسل في صورة بروتوكول إلى الجهاز.
getUpdatedTimeInfoResult

/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}

الحصول

تلقّي معلومات وقت الجهاز التي تم تحريرها من جهاز. تكون واجهة برمجة التطبيقات هذه قابلة للتنفيذ بعد تنفيذ خدمة الحصول على نتيجة معلومات الوقت المحدّثة.

listDeviceGroupOrgan

/restapi/v1.0/rms/devices/groups

الحصولاستيراد قائمة التنظيمات.
listDeviceGroupInfo

/restapi/v1.0/rms/devices/groups/{groupId}

الحصولاستيراد تفاصيل المجموعة {groupId}.
listDeviceGroupChild

/restapi/v1.0/rms/devices/groups/{groupId}/child

الحصولاستيراد معلومات حول المجموعات الفرعية تحت {groupId}.

المستخدم

إضافة مستخدمين وإدارة معلومات المستخدم. يمكن للمستخدمين المصادقين من ذوي الامتيازات الخاصّة بقراءة معلومات المستخدم وكتابتها وإدارتها الوصول إلى الخدمات المرتبطة بالمستخدم.

فيما يلي خدمات إدارة المستخدم المتاحة:

اسم الخدمة

استدعاء API

نوع الاستدعاءالوصف
createUser/restapi/v1.0/ums/usersنشرإضافة مستخدم.
listDashboardUserInfo

/restapi/v1.0/ums/users/dashboard

الحصولاستيراد معلومات المستخدم الضرورية من لوحة المعلومات.
updateMyInfo

/restapi/v1.0/ums/users/me

وضعتحرير معلومات المستخدم.
listUserOrgan

/restapi/v1.0/ums/users/organization

الحصولاستيراد قائمة التنظيمات. يمكن استخدام هذا الخيار لتكوين شجرة المجموعة.
listUserGroupOrgan

/restapi/v1.0/ums/users/groups

الحصولاستيراد قائمة التنظيمات.
listUserGroupInfo

/restapi/v1.0/ums/users/groups/{groupId}

الحصولاستيراد تفاصيل المجموعة {groupId}.
listUserGroupChild

/restapi/v1.0/ums/users/groups/{groupId}/child

الحصولاستيراد قائمة المجموعات الفرعية تحت المجموعة {groupId}.

الضبط

إضافة إلى الوظائف الرئيسة، يمكنك استخدام العديد من الوظائف الأخرى لإنشاء العلامات والفئات وإدارتها، فضلاً عن تحرير لوحة المعلومات.

اسم الخدمة

استدعاء API

نوع الاستدعاءالوصف
getCategoryInfo

/restapi/v1.0/ems/category/{categoryId}

الحصولاستيراد قائمة بالفئات.
deleteDashboard

/restapi/v1.0/ems/dashboard

حذفحذف معلومات لوحة المعلومات المحددة.
listDashboardInfo

/restapi/v1.0/ems/dashboard

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

/restapi/v1.0/ems/dashboard

وضعتغيير ترتيب العناصر المعروضة على لوحة المعلومات.
createDashboard

/restapi/v1.0/ems/dashboard/create

الحصولتنشيط لوحة معلومات خاملة.

listDashboardLoginInfo

/restapi/v1.0/ems/dashboard/login

الحصولاستيراد معلومات تسجيل الدخول ليتم عرضها على لوحة المعلومات.
listDashboardNoticeInfo

/restapi/v1.0/ems/dashboard/notice

الحصولاستيراد معلومات لوحة النشرات ليتم عرضها على لوحة المعلومات.
deleteNoticeInfo

/restapi/v1.0/ems/dashboard/notice/edit

حذفحذف منشور من لوحة النشرات.
listEditNoticeInfo

/restapi/v1.0/ems/dashboard/notice/edit

الحصولاستيراد تفاصيل المنشور المحدد.
createNoticeInfo

/restapi/v1.0/ems/dashboard/notice/edit

نشرإضافة منشورات إلى لوحة النشرات.
updateNoticeInfo

/restapi/v1.0/ems/dashboard/notice/edit

وضعتحرير المنشور المحدد على لوحة النشرات.
listDashboardStorageInfo

/restapi/v1.0/ems/dashboard/storage

الحصولاستيراد معلومات التخزين ليتم عرضها على لوحة المعلومات.

listLicense

/restapi/v1.0/ems/license

الحصولاستيراد قائمة التراخيص المسجلة على الخادم.
getServerSetupInfo

/restapi/v1.0/ems/setup

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

/restapi/v1.0/ems/tag

نشراستيراد قائمة العلامات المسجلة على الخادم.


تفاصيل واجهة برمجة التطبيقات المفتوحة (واجهة مستخدم Swagger)

http://184.169.167.38:7001/MagicInfo/swagger-ui.html



Sv translation
languagefr


MagicINFO Server vous permet de mettre en place une gestion du contenu, une gestion des programmes, une gestion des périphériques et d’autres fonctions en appelant Open API (v2.0).

Pour utiliser Open API (v2.0), vous devez d’abord effectuer un processus d’authentification. Utilisez une page Swagger distincte pour tester chaque API.

Authentification

Lorsque vous appelez tous les éléments Open API (v2.0), vous devez inclure api_token dans l’en-tête. Si ceci n’est pas inclus, une erreur « 401 Unauthorized » est renvoyée.

Un jeton obtenu expire et devient inutilisable après une durée définie. Si tel est le cas, vous devez obtenir un nouveau jeton.

Il est possible d’obtenir api_token en appelant l’API suivante.

Nom du service

Requête API

Type de requêteDescription
authenticationRequest

/auth

POSTImporte une valeur de jeton pour l’authentification à l’aide de l’identifiant d’utilisateur et du mot de passe.
authenticationRequest

/auth/refresh

GETCrée un nouveau jeton pour étendre le délai d’expiration. Il est possible d’appeler REST API sans se reconnecter

OPEN API (v2.0)

MagicINFO Server Open API (v2.0) fournit diverses fonctions. La configuration de chaque fonction est indiquée ci-dessous.

CatégorieContrôleurDescription
Contenu :content-controllerGestion du contenu
content-group-controllerGestion du groupe de contenu
Liste de lectureplaylist-controllerGestion des listes de lecture
playlist-group-controllerGestion du groupe de listes de lecture
Programmecontent-schedule-controllerGestion du programme de contenu
content-schedule-group-controllerGestion du groupe de programmes de contenu
message-schedule-controllerGestion des programmes de messages
message-schedule-group-controllerGestion du groupe de programmes de message
Périphériquedevice-controllerGestion des périphériques
device-group-controllerGestion du groupe de périphériques
Utilisateuruser-controllerGestion des utilisateurs
user-group-controllerGestion du groupe d’utilisateurs
Réglageenvironment-controllerRéglage

Contenu :

Téléchargez, approuvez ou supprimez du contenu. Gérez des listes de contenu. Les services relatifs au contenu sont accessibles pour les utilisateurs authentifiés possédant les privilèges nécessaires pour lire, écrire et gérer du contenu.

Les services disponibles de gestion de contenu sont comme suit :

Nom du service

Requête API

Type de requêteDescription
listAllContent

/restapi/v1.0/cms/contents

GETPermet d’importer une liste du contenu téléchargé. La liste inclut les vignettes de contenu, les noms, les types de fichiers et d’autres informations de base. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
listDashboardContentInfo

/restapi/v1.0/cms/contents/dashboard

GETPermet d’importer des informations de contenu générales à afficher sur le tableau de bord.
listContent

/restapi/v1.0/cms/contents/filter

POSTPermet d’importer une liste de contenu filtré selon des conditions. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
forceDeleteContent

/restapi/v1.0/cms/contents/force/{contentId}

DELETESupprime du contenu, que le contenu soit inclus ou non dans une liste de lecture ou un programme.
deleteContent

/restapi/v1.0/cms/contents/{contentId}

DELETESupprime du contenu après avoir vérifié que le contenu n’est pas inclus dans une liste de lecture ou un programme. Si vous tentez de supprimer du contenu inclus dans une liste de lecture ou un programme, le contenu n’est pas supprimé et un code d’erreur est renvoyé.
getActiveContentInfo

/restapi/v1.0/cms/contents/{contentId}

GETPermet d’importer les détails d’une version activée du contenu. La version du contenu est mise à jour à chaque fois que le contenu est modifié.
approveContents

/restapi/v1.0/cms/contents/{contentId}/approval

PUTPermet d’approuver/de rejeter du contenu. Le contenu approuvé est déplacé dans la liste de contenu général et peut être utilisé dans des listes de lecture ou des programmes.
uploadContent

/restapi/v1.0/cms/contents/{groupId}

POSTPermet de télécharger du nouveau contenu.

listDefaultGroup

/restapi/v1.0/cms/contents/groups

GETPermet d’importer une liste des groupes de contenu par défaut.
getGroup

/restapi/v1.0/cms/contents/groups/{groupId}

GETPermet d’importer les détails du groupe {groupId}.
listChildGroup

/restapi/v1.0/cms/contents/groups/{groupId}/child

GETPermet d’importer une liste de sous-groupes dans le groupe {groupId}.


Liste de lecture

Utilisez du contenu pour créer, modifier ou supprimer des listes de lecture. Les services relatifs aux listes de lecture sont accessibles pour les utilisateurs authentifiés possédant les privilèges nécessaires pour lire, écrire et gérer du contenu.

Les services disponibles de gestion de liste de lecture sont comme suit :

Nom du service

Requête API

Type de requêteDescription
listAllPlaylist

/restapi/v1.0/cms/playlists

GETPermet d’importer une liste de toutes les listes de lecture. La liste inclut les noms des listes de lecture, les vignettes de contenu principales, les types de listes de lecture et d’autres informations de base. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
createPlaylist

/restapi/v1.0/cms/playlists

POSTCrée une nouvelle liste de lecture.

getDashboardPlaylistInfo

/restapi/v1.0/cms/playlists/dashboard

GETPermet d’importer depuis le tableau de bord des informations de liste de lecture indispensables.

listPlaylist

/restapi/v1.0/cms/playlists/filter

POSTPermet d’importer une liste des listes de lecture filtrées selon des conditions. Vous pouvez importer les listes par page à l’aide d’informations de recherche.

deletePlaylist

/restapi/v1.0/cms/playlists/{playlistId}

DELETESupprime la liste de lecture sélectionnée. Si vous tentez de supprimer une liste de lecture incluse dans un programme, la liste de lecture n’est pas supprimée et un code d’erreur est renvoyé.

getActivePlaylistInfo

/restapi/v1.0/cms/playlists/{playlistId}

GETPermet d’importer les détails d’une version activée d’une liste de lecture. La version d’une liste de lecture est mise à jour à chaque fois que cette liste de lecture est modifiée.

editPlaylist

/restapi/v1.0/cms/playlists/{playlistId}

PUTModifie la liste de lecture {playlistId}. La modification d’une liste de lecture actualise la version de cette liste de lecture. Ainsi, le périphérique lisant la liste de lecture lit automatiquement la version mise à jour.

copyPlaylist

/restapi/v1.0/cms/playlists/{playlistId}/copy

PUTCopie la liste de lecture {playlistId}. Un duplicata de la liste de lecture est créé.
listDefaultGroup

/restapi/v1.0/cms/playlists/groups

GETPermet d’importer une liste des groupes de listes de lecture par défaut.

getGroup

/restapi/v1.0/cms/playlists/groups/{groupId}

GETPermet d’importer les détails du groupe {groupId}.
listChildGroup/restapi/v1.0/cms/playlists/groups/{groupId}/childGET

Permet d’importer une liste de sous-groupes dans le groupe {groupId}.

Programme

Créez de nouveaux programmes de contenu ou de message. Publiez des programmes sur des périphériques pour la lecture. Modifiez ou supprimez des programmes.

Les services relatifs aux programmes sont accessibles pour les utilisateurs authentifiés possédant les privilèges nécessaires pour lire, écrire et gérer des programmes.

Les services disponibles de gestion de programme sont comme suit :

Nom du service

Requête API

Type de requêteDescription
listContentScheduleAll

/restapi/v1.0/dms/schedule/contents

GETPermet d’importer une liste de tous les programmes de contenu. La liste inclut les noms des programmes de contenu, les dates de création, les types de périphériques et d’autres informations de base. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
createContentSchedule

/restapi/v1.0/dms/schedule/contents

POSTPermet de créer un nouveau programme de contenu. Un programme de contenu peut contenir plusieurs canaux et cadres. Publiez un programme sur des périphériques et lisez le contenu souhaité ou la liste de lecture à un moment spécifié.
listDashboardScheduleInfo

/restapi/v1.0/dms/schedule/contents/dashboard

GETPermet d’importer depuis le tableau de bord des informations de programme de contenu indispensables.
listContentScheduleByGroup

/restapi/v1.0/dms/schedule/contents/filter

POSTPermet d’importer une liste de programmes de contenu filtrés selon différentes conditions. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
deleteContentSchedule

/restapi/v1.0/dms/schedule/contents/{programId}

DELETESupprime un programme de contenu. En cas de suppression d’un programme précédemment publié sur un périphérique, le périphérique lit automatiquement le contenu par défaut.
getProgramInfo

/restapi/v1.0/dms/schedule/contents/{programId}

GETPermet d’importer les détails du programme sélectionné.
editContentSchedule

/restapi/v1.0/dms/schedule/contents/{programId}

PUTPermet de modifier un programme de contenu. En cas de modification d’un programme précédemment publié sur un périphérique, le périphérique lit automatiquement le programme modifié.
copyContentSchedule

/restapi/v1.0/dms/schedule/contents/{programId}/copy

PUTPermet de copier le programme de contenu {programId}. Un duplicata du programme de contenu {programId} est créé.
deployContentSchedule

/restapi/v1.0/dms/schedule/contents/{programId}/deploy

PUTPermet de publier un programme de contenu sur un groupe de périphériques spécifique.
getPublishStatus

/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus

GETPermet d’importer le statut de téléchargement en temps réel d’un programme de contenu depuis un périphérique.
getRootGroups

/restapi/v1.0/dms/schedule/contents/groups

GETPermet d’importer une liste de tous les groupes de racine pour un programme de contenu.
listContentScheduleGroupInfo/restapi/v1.0/dms/schedule/contents/groups/{groupId}GETPermet d’importer les détails du groupe {groupId}.
listAllMessageSchedule

/restapi/v1.0/dms/schedule/messages

GETPermet d’importer une liste de tous les programmes de message.
createMessageSchedule

/restapi/v1.0/dms/schedule/messages

POSTPermet de créer un nouveau programme de message.
listMessage

/restapi/v1.0/dms/schedule/messages/filter

POST

Permet d’importer une liste de programmes de message filtrés selon différentes conditions. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
deleteMessageSchedule

/restapi/v1.0/dms/schedule/messages/{messageId}

DELETESupprime le programme de message sélectionné. En cas de suppression d’un programme de message précédemment publié sur un périphérique, la modification est appliquée automatiquement au périphérique.
getMessageInfo

/restapi/v1.0/dms/schedule/messages/{messageId}

GETPermet d’importer les détails du programme de message sélectionné.
editMessageSchedule

/restapi/v1.0/dms/schedule/messages/{messageId}

PUTPermet d’éditer le programme de message sélectionné. En cas de modification d’un programme de message précédemment publié sur un périphérique, la modification est appliquée automatiquement au périphérique.
copyMessageSchedule

/restapi/v1.0/dms/schedule/messages/{messageId}/copy

PUTPermet de copier le programme de message sélectionné. Un duplicata du programme de message est créé.
deployMessageSchedule

/restapi/v1.0/dms/schedule/messages/{messageId}/deploy

PUTPermet de publier le programme de message sélectionné sur un groupe de périphériques.
getRootGroups

/restapi/v1.0/dms/schedule/messages/groups

GETPermet d’importer une liste de tous les groupes de racine pour un programme de contenu.
listMessageScheduleGroupInfo

/restapi/v1.0/dms/schedule/messages/groups/{groupId}

GETPermet d’importer les détails du groupe {groupId}.
getChildGroups

/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child

GETPermet d’importer une liste de sous-groupes dans un groupe spécifique.

Périphérique

Contrôlez et gérez les périphériques. Les services relatifs aux périphériques sont accessibles pour les utilisateurs authentifiés possédant les privilèges nécessaires pour lire, écrire et gérer des périphériques.

Les services disponibles de gestion de périphérique sont comme suit :

Nom du service

Requête API

Type de requêteDescription
listAllDevice

/restapi/v1.0/rms/devices

GETPermet d’importer une liste de tous les périphériques. La liste inclut l’état d’alimentation du périphérique, les informations de vignette, le statut d’erreur du périphérique et d’autres informations de base. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
getDashboardDeviceInfo

/restapi/v1.0/rms/devices/dashboard

GETPermet d’importer depuis le tableau de bord des informations de périphérique indispensables.
filterDeviceList

/restapi/v1.0/rms/devices/filter

POSTPermet d’importer une liste de périphériques filtrés selon différentes conditions. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
deleteDevice

/restapi/v1.0/rms/devices/{deviceId}

DELETESupprime le périphérique sélectionné.
getDevice

/restapi/v1.0/rms/devices/{deviceId}

GETPermet d’importer les détails du périphérique sélectionné.
approveDevice

/restapi/v1.0/rms/devices/{deviceId}/approval

PUTPermet d’approuver le périphérique sélectionné sur un groupe spécifique.
getCabinetList

/restapi/v1.0/rms/devices/{deviceId}/cabinet

POSTPermet d’importer des informations sur les cabinets connectés à un périphérique LED. Les informations importées sont valides uniquement lorsque les cabinets sont connectés à un périphérique LED.
updateCabinetInfo

/restapi/v1.0/rms/devices/{deviceId}/cabinet

PUTPermet de modifier des informations sur les cabinets connectés à un périphérique LED.
getDisplayControlInfo

/restapi/v1.0/rms/devices/{deviceId}/display

GETPermet d’importer des informations de contrôle d’affichage du périphérique depuis la base de données. S’il n’y a pas d’informations de contrôle, une requête d’informations doit être envoyée au périphérique.
updateDisplayInfo

/restapi/v1.0/rms/devices/{deviceId}/display

PUTPermet d’envoyer sur un périphérique des informations de contrôle d’affichage modifiées. Seules les valeurs modifiées dans les informations d’affichage sont envoyées au périphérique en tant que protocole.
getUpdatedDisplayInfoResult

/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}

GETPermet de recevoir depuis un périphérique des informations de contrôle d’affichage modifiées. Cette API peut être exécutée après l’exécution de l’API updateDisplayInfo.
getGeneralInfo

/restapi/v1.0/rms/devices/{deviceId}/general

GETPermet d’importer des informations de périphérique générales depuis la base de données. Les informations de périphérique générales sont actualisées lorsque le périphérique se connecte au serveur.
updateGeneralInfo

/restapi/v1.0/rms/devices/{deviceId}/general/info

PUTPermet d’envoyer sur un périphérique des informations de périphérique modifiées. Seules les valeurs modifiées dans les informations de périphérique de base sont envoyées au périphérique en tant que protocole.
getUpdatedGeneralInfoResult

/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}

GETPermet de recevoir depuis un périphérique des informations de périphérique modifiées. Cette API peut être exécutée après l’exécution de l’API updateGeneralInfo.
moveDevice

/restapi/v1.0/rms/devices/{deviceId}/move

PUTPermet de déplacer un périphérique sur un autre groupe.
startRmServerVnc

/restapi/v1.0/rms/devices/{deviceId}/rmserver/start

GETPermet d’envoyer sur un périphérique un protocole de démarrage RM. Un périphérique ayant reçu un protocole de démarrage RM envoie régulièrement des informations via le serveur de la télécommande.
stopRmServerVnc

/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop

GETPermet d’envoyer sur un périphérique un protocole d’arrêt RM. Un périphérique ayant reçu un protocole d’arrêt arrête immédiatement la fonction correspondante.
getSetupInfo

/restapi/v1.0/rms/devices/{deviceId}/setup

GETPermet d’importer des paramètres relatifs à un périphérique. Les paramètres de périphérique sont actualisés lorsque le périphérique se connecte au serveur.
updateSetupInfo

/restapi/v1.0/rms/devices/{deviceId}/setup

PUTPermet d’envoyer sur un périphérique des paramètres de périphérique modifiés. Seules les valeurs modifiées dans les paramètres sont envoyées au périphérique en tant que protocole.
getUpdatedSetupInfoResult

/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}

GETPermet de recevoir depuis un périphérique des paramètres de périphérique modifiés. Cette API peut être exécutée après l’exécution de l’API updateSetupInfo.
getCurrentStatusDisplay

/restapi/v1.0/rms/devices/{deviceId}/status/display

GETPermet d’envoyer sur un périphérique une requête d’informations actuelles de contrôle d’affichage. Si vous appelez cette API, vous recevez requestId comme valeur de réponse.
getCurrentStatusDisplay

/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}

GETPermet d’importer depuis un périphérique des informations de contrôle d’affichage. Cette option est utilisée pour deux actions : envoyer une requête d’informations à un périphérique et recevoir des informations actuelles sur le périphérique.
getCurrentStatusTime

/restapi/v1.0/rms/devices/{deviceId}/status/time

GETPermet d’envoyer sur un périphérique une requête d’informations actuelles concernant l’heure. Si vous appelez cette API, vous recevez requestId comme valeur de réponse.
getCurrentStatusTime

/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}

GETPermet d’importer des informations sur l’heure envoyées depuis un périphérique. Cette option est utilisée pour deux actions : envoyer une requête d’informations à un périphérique et recevoir des informations actuelles sur le périphérique.
getTimeInfo

/restapi/v1.0/rms/devices/{deviceId}/time

GETPermet d’importer des informations sur l’heure du périphérique depuis la base de données. S’il n’y a pas d’informations de contrôle, une requête d’informations doit être envoyée au périphérique.
updateTimeInfo

/restapi/v1.0/rms/devices/{deviceId}/time

PUTPermet d’envoyer sur un périphérique des informations modifiées concernant l’heure. Seules les valeurs modifiées dans les informations sur l’heure sont envoyées au périphérique en tant que protocole.
getUpdatedTimeInfoResult

/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}

GET

Permet de recevoir depuis un périphérique des informations modifiées sur l’heure du périphérique. Cette API peut être exécutée après l’exécution de l’API getUpdatedTimeInfoResult.

listDeviceGroupOrgan

/restapi/v1.0/rms/devices/groups

GETPermet d’importer une liste d’organisations.
listDeviceGroupInfo

/restapi/v1.0/rms/devices/groups/{groupId}

GETPermet d’importer les détails du groupe {groupId}.
listDeviceGroupChild

/restapi/v1.0/rms/devices/groups/{groupId}/child

GETPermet d’importer des informations de sous-groupes dans {groupId}.

Utilisateur

Ajoutez des utilisateurs et gérez les informations d’utilisateur. Les services relatifs aux utilisateurs sont accessibles pour les utilisateurs authentifiés possédant les privilèges nécessaires pour lire, écrire et gérer les informations d’utilisateur.

Les services disponibles de gestion d’utilisateur sont comme suit :

Nom du service

Requête API

Type de requêteDescription
createUser/restapi/v1.0/ums/usersPOSTPermet d’ajouter un utilisateur.
listDashboardUserInfo

/restapi/v1.0/ums/users/dashboard

GETPermet d’importer depuis le tableau de bord des informations d’utilisateur indispensables.
updateMyInfo

/restapi/v1.0/ums/users/me

PUTPermet de modifier les informations relatives à l’utilisateur.
listUserOrgan

/restapi/v1.0/ums/users/organization

GETPermet d’importer une liste d’organisations. Cette option peut être utilisée pour configurer une arborescence de groupes.
listUserGroupOrgan

/restapi/v1.0/ums/users/groups

GETPermet d’importer une liste d’organisations.
listUserGroupInfo

/restapi/v1.0/ums/users/groups/{groupId}

GETPermet d’importer les détails du groupe {groupId}.
listUserGroupChild

/restapi/v1.0/ums/users/groups/{groupId}/child

GETPermet d’importer une liste de sous-groupes dans le groupe {groupId}.

Réglage

En plus des fonctions principales, vous pouvez utiliser de nombreuses autres fonctions pour créer et gérer des tags et des catégories, et modifier le tableau de bord.

Nom du service

Requête API

Type de requêteDescription
getCategoryInfo

/restapi/v1.0/ems/category/{categoryId}

GETPermet d’importer une liste de catégories.
deleteDashboard

/restapi/v1.0/ems/dashboard

DELETEPermet de supprimer des informations de tableau de bord spécifiques.
listDashboardInfo

/restapi/v1.0/ems/dashboard

GETPermet d’importer du contenu à afficher sur le tableau de bord personnalisé. Vous ne pouvez afficher que des informations spécifiques sur le tableau de bord.
updateDashboardPriority

/restapi/v1.0/ems/dashboard

PUTPermet de changer l’ordre des éléments affichés sur le tableau de bord.
createDashboard

/restapi/v1.0/ems/dashboard/create

GETPermet d’activer un tableau de bord inactif.

listDashboardLoginInfo

/restapi/v1.0/ems/dashboard/login

GETPermet d’importer des informations de connexion à afficher sur le tableau de bord.
listDashboardNoticeInfo

/restapi/v1.0/ems/dashboard/notice

GETPermet d’importer des informations de tableau d’affichage à afficher sur le tableau de bord.
deleteNoticeInfo

/restapi/v1.0/ems/dashboard/notice/edit

DELETEPermet de supprimer une publication du tableau d’affichage.
listEditNoticeInfo

/restapi/v1.0/ems/dashboard/notice/edit

GETPermet d’importer les détails de la publication sélectionnée.
createNoticeInfo

/restapi/v1.0/ems/dashboard/notice/edit

POSTPermet d’ajouter des publications au tableau d’affichage.
updateNoticeInfo

/restapi/v1.0/ems/dashboard/notice/edit

PUTPermet de modifier la publication sélectionnée sur le tableau d’affichage.
listDashboardStorageInfo

/restapi/v1.0/ems/dashboard/storage

GETPermet d’importer des informations de stockage à afficher sur le tableau de bord.

listLicense

/restapi/v1.0/ems/license

GETPermet d’importer une liste de licences enregistrées sur le serveur.
getServerSetupInfo

/restapi/v1.0/ems/setup

GETPermet d’importer des paramètres relatifs au serveur. Les éléments de réglage du serveur incluent des options qui peuvent activer ou désactiver différentes fonctions sur le serveur.
getTagListInfo

/restapi/v1.0/ems/tag

POSTPermet d’importer une liste de tags enregistrés sur le serveur.


Détails sur Open API (interface utilisateur Swagger)

http://184.169.167.38:7001/MagicInfo/swagger-ui.html