Page History

Versions Compared

Old Version 77

changes.mady.by.user user-f347e

Saved on Aug 01, 2018

compared with

New Version Current

changes.mady.by.user user-f347e

Saved on Oct 08, 2018

Key

This line was added.
This line was removed.
Formatting was changed.

...

Sv translation

language	ar

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

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

التصديق

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

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

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

اسم الخدمة	استدعاء API	نوع الاستدعاء	الوصف
طلب المصادقة	/auth	نشرPOST	استيراد قيمة الرمز المميّز للمصادقة باستخدام هوية المستخدم وكلمة المرور.
طلب المصادقة	/auth/refresh	الحصولGET	إنشاء رمز مميّز جديد لتمديد وقت انتهاء الصلاحية. من الممكن استدعاء 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	الحصولGET	استيراد قائمة بالمحتوى الذي تم تحميله. تكون الصور المصغرة للمحتوى والأسماء وأنواع الملفات وغيرها من المعلومات الأساسية الأخرى متضمنة في القائمة. يمكن استيراد القوائم لكل صفحة باستخدام معلومات الترحيل.
listDashboardContentInfo	/restapi/v1.0/cms/contents/dashboard	الحصولGET	استيراد معلومات المحتوى العامة ليتم عرضها على لوحة المعلومات.
listContent	/restapi/v1.0/cms/contents/filter	نشرPOST	استيراد قائمة بالمحتوى المرشّح اعتمادًا على الحالات. يمكن استيراد القوائم لكل صفحة باستخدام معلومات الترحيل.
forceDeleteContent	/restapi/v1.0/cms/contents/force/{contentId}	حذفDELETE	حذف المحتوى سواء كان المحتوى متضمنًا في قائمة تشغيل أو جدول أم لا.
deleteContent	/restapi/v1.0/cms/contents/{contentId}	حذفDELETE	حذف المحتوى بعد التحقّق من أنه غير متضمن في قائمة تشغيل أو جدول. إذا كنت تحاول حذف محتوى متضمن في قائمة تشغيل أو جدول، فلن يتم حذف المحتوى وسيظهر رمز خطأ.
getActiveContentInfo	/restapi/v1.0/cms/contents/{contentId}	الحصولGET	استيراد تفاصيل إصدار منشَّط من المحتوى. يتم تحديث إصدار المحتوى في كل مرة يتم خلالها تحرير المحتوى.
approveContents	/restapi/v1.0/cms/contents/{contentId}/approval	وضعPUT	اعتماد/رفض المحتوى. يتم نقل المحتوى المعتمد إلى قائمة المحتوى العام ويمكن استخدامه في قوائم التشغيل أو الجداول.
uploadContent	/restapi/v1.0/cms/contents/{groupId}	نشرPOST	تحميل محتوى جديد.
listDefaultGroup	/restapi/v1.0/cms/contents/groups	الحصولGET	استيراد قائمة مجموعات المحتوى الافتراضي.
getGroup	/restapi/v1.0/cms/contents/groups/{groupId}	الحصولGET	استيراد تفاصيل المجموعة {groupId}.
listChildGroup	/restapi/v1.0/cms/contents/groups/{groupId}/child	الحصولGET	استيراد قائمة المجموعات الفرعية تحت المجموعة {groupId}.

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

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

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

اسم الخدمة	استدعاء API	نوع الاستدعاء	الوصف
listAllPlaylist	/restapi/v1.0/cms/playlists	الحصولGET	استيراد قائمة بجميع قوائم التشغيل. تكون أسماء قوائم التشغيل والصور المصغرة للمحتوى الرئيس وأنواع قوائم التشغيل وغيرها من المعلومات الأساسية الأخرى متضمنة في القائمة. يمكن استيراد القوائم لكل صفحة باستخدام معلومات الترحيل.
createPlaylist	/restapi/v1.0/cms/playlists	نشرPOST	إنشاء قائمة تشغيل جديدة.
getDashboardPlaylistInfo	/restapi/v1.0/cms/playlists/dashboard	الحصولGET	استيراد معلومات قوائم التشغيل الضرورية من لوحة المعلومات.
listPlaylist	/restapi/v1.0/cms/playlists/filter	نشرPOST	استيراد قائمة بقوائم التشغيل المرشّحة اعتمادًا على الحالات. يمكن استيراد القوائم لكل صفحة باستخدام معلومات الترحيل.
deletePlaylist	/restapi/v1.0/cms/playlists/{playlistId}	حذفDELETE	حذف قائمة التشغيل المحدّدة. إذا كنت تحاول حذف قائمة تشغيل متضمنة في جدول، فلن يتم حذف قائمة التشغيل وسيظهر رمز خطأ.
getActivePlaylistInfo	/restapi/v1.0/cms/playlists/{playlistId}	الحصولGET	استيراد تفاصيل إصدار منشَّط من قائمة التشغيل. يتم تحديث إصدار قائمة التشغيل في كل مرة يتم خلالها تحرير قائمة التشغيل.
editPlaylist	/restapi/v1.0/cms/playlists/{playlistId}	وضعPUT	تحرير قائمة التشغيل {playlistId}. يعمل تحرير قائمة تشغيل على تحديث إصدار قائمة التشغيل، ويتسبب في تشغيل الجهاز الذي يشغّل قائمة التشغيل لقائمة التشغيل المحدّثة تلقائيًا.
copyPlaylist	/restapi/v1.0/cms/playlists/{playlistId}/copy	وضعPUT	نسخ قائمة التشغيل {playlistId}. يتم إنشاء نسخة مكرّرة من قائمة التشغيل.
listDefaultGroup	/restapi/v1.0/cms/playlists/groups	الحصولGET	استيراد قائمة مجموعات قوائم التشغيل الافتراضية.
getGroup	/restapi/v1.0/cms/playlists/groups/{groupId}	الحصولGET	استيراد تفاصيل المجموعة {groupId}.
listChildGroup	/restapi/v1.0/cms/playlists/groups/{groupId}/child	الحصولGET	استيراد قائمة المجموعات الفرعية تحت المجموعة {groupId}.

جدول

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

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

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

اسم الخدمة	استدعاء API	نوع الاستدعاء	الوصف
listContentScheduleAll	/restapi/v1.0/dms/schedule/contents	الحصولGET	استيراد قائمة جميع جداول المحتوى. تكون أسماء جدول المحتوى وتواريخ الإنشاء وأنواع الأجهزة وغيرها من المعلومات الأساسية الأخرى متضمنة في القائمة. يمكن استيراد القوائم لكل صفحة باستخدام معلومات الترحيل.
createContentSchedule	/restapi/v1.0/dms/schedule/contents	نشرPOST	إنشاء جدول محتوى جديد. يمكن أن يحتوي جدول المحتوى على العديد من القنوات والإطارات. نشر جدول للأجهزة وتشغيل المحتوى المطلوب أو قائمة التشغيل في وقت محدّد.
listDashboardScheduleInfo	/restapi/v1.0/dms/schedule/contents/dashboard	الحصولGET	استيراد معلومات جدول المحتوى الضرورية من لوحة المعلومات.
listContentScheduleByGroup	/restapi/v1.0/dms/schedule/contents/filter	نشرPOST	استيراد قائمة بجداول المحتوى المرشّحة اعتمادًا على الحالات المختلفة. يمكن استيراد القوائم لكل صفحة باستخدام معلومات الترحيل.
deleteContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	حذفDELETE	حذف جدول محتوى. في حالة حذف جدول منشور مسبقًا في جهاز، يشغل الجهاز تلقائيًا المحتوى الافتراضي.
getProgramInfo	/restapi/v1.0/dms/schedule/contents/{programId}	الحصولGET	استيراد تفاصيل الجدول المحدد.
editContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	وضعPUT	تحرير جدول محتوى. في حالة تحرير جدول منشور مسبقًا في جهاز، يشغل الجهاز تلقائيًا الجدول الذي تم تحريره.
copyContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/copy	وضعPUT	نسخ جدول المحتوى {programId}. يتم إنشاء نسخة مكرّرة من جدول المحتوى {programId}.
deployContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/deploy	وضعPUT	نشر جدول محتوى في مجموعة جهاز محدّدة.
getPublishStatus	/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus	الحصولGET	استيراد حالة تنزيل جدول المحتوى في الوقت الحقيقي من جهاز.
getRootGroups	/restapi/v1.0/dms/schedule/contents/groups	الحصولGET	استيراد قائمة مجموعات الجذر لجدول محتوى.
listContentScheduleGroupInfo	/restapi/v1.0/dms/schedule/contents/groups/{groupId}	الحصولGET	استيراد تفاصيل المجموعة {groupId}.
listAllMessageSchedule	/restapi/v1.0/dms/schedule/messages	الحصولGET	استيراد قائمة جميع جداول الرسائل.
createMessageSchedule	/restapi/v1.0/dms/schedule/messages	نشرPOST	إنشاء جدول رسالة جديد.
إدراج الرسالة	/restapi/v1.0/dms/schedule/messages/filter	نشرPOST	استيراد قائمة بجداول الرسائل المرشّحة اعتمادًا على الحالات المختلفة. يمكن استيراد القوائم لكل صفحة باستخدام معلومات الترحيل.
deleteMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	حذفDELETE	حذف جدول الرسائل المحدّد. في حالة حذف جدول رسائل منشور مسبقًا في جهاز، ينطبق التغيير تلقائيًا على الجهاز.
getMessageInfo	/restapi/v1.0/dms/schedule/messages/{messageId}	الحصولGET	استيراد تفاصيل جدول الرسائل المحدد.
editMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	وضعPUT	تحرير جدول الرسائل المحدّد. في حالة تحرير جدول رسائل منشور مسبقًا في جهاز، ينطبق التغيير تلقائيًا على الجهاز.
copyMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/copy	وضعPUT	نسخ جدول الرسائل المحدّد. يتم إنشاء نسخة مكرّرة من جدول الرسائل.
deployMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/deploy	وضعPUT	نشر جدول الرسائل المحدّد على مجموعة جهاز.
getRootGroups	/restapi/v1.0/dms/schedule/messages/groups	الحصولGET	استيراد قائمة مجموعات الجذر لجدول محتوى.
listMessageScheduleGroupInfo	/restapi/v1.0/dms/schedule/messages/groups/{groupId}	الحصولGET	استيراد تفاصيل المجموعة {groupId}.
getChildGroups	/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child	الحصولGET	استيراد قائمة المجموعات الفرعية تحت المجموعة المحددة.

الجهاز

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

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

اسم الخدمة	استدعاء API	نوع الاستدعاء	الوصف
listAllDevice	/restapi/v1.0/rms/devices	الحصولGET	استيراد قائمة بجميع الأجهزة. تكون حالة طاقة الجهاز ومعلومات الصورة المصغرة وحالة خطأ الجهاز وغيرها من المعلومات الأساسية الأخرى متضمنة في القائمة. يمكن استيراد القوائم لكل صفحة باستخدام معلومات الترحيل.
getDashboardDeviceInfo	/restapi/v1.0/rms/devices/dashboard	الحصولGET	استيراد معلومات الأجهزة الضرورية من لوحة المعلومات.
filterDeviceList	/restapi/v1.0/rms/devices/filter	نشرPOST	استيراد قائمة بالأجهزة المرشّحة اعتمادًا على الحالات المختلفة. يمكن استيراد القوائم لكل صفحة باستخدام معلومات الترحيل.
deleteDevice	/restapi/v1.0/rms/devices/{deviceId}	حذفDELETE	حذف الجهاز المحدّد.
getDevice	/restapi/v1.0/rms/devices/{deviceId}	الحصولGET	استيراد تفاصيل الجهاز المحدد.
approveDevice	/restapi/v1.0/rms/devices/{deviceId}/approval	وضعPUT	اعتماد الجهاز المحدّد لمجموعة محددة.
getCabinetList	/restapi/v1.0/rms/devices/{deviceId}/cabinet	نشرPOST	استيراد معلومات حول الخزائن المتصلة بجهاز LED. تكون المعلومات المستوردة صالحة فقط عند اتصال الخزائن بجهاز LED.
updateCabinetInfo	/restapi/v1.0/rms/devices/{deviceId}/cabinet	وضعPUT	تحرير معلومات حول الخزائن المتصلة بجهاز LED.
getDisplayControlInfo	/restapi/v1.0/rms/devices/{deviceId}/display	الحصولGET	استيراد معلومات التحكّم في عرض الجهاز من لوحة المعلومات. في حالة عدم وجود معلومات التحكم، يجب إرسال طلب الحصول على المعلومات إلى الجهاز.
updateDisplayInfo	/restapi/v1.0/rms/devices/{deviceId}/display	وضعPUT	إرسال معلومات التحكّم في العرض إلى جهاز. يقتصر الإرسال على القيم التي تم تحريرها ضمن معلومات العرض فقط وتُرسل في صورة بروتوكول إلى الجهاز.
getUpdatedDisplayInfoResult	/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}	الحصولGET	تلقّي معلومات التحكّم في العرض التي تم تحريرها من جهاز. تكون واجهة برمجة التطبيقات هذه قابلة للتنفيذ بعد تنفيذ خدمة تحديث معلومات العرض.
getGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general	الحصولGET	استيراد معلومات الأجهزة العامة من قاعدة البيانات. يتم تحديث معلومات الأجهزة العامة عند اتصال الجهاز بالخادم.
updateGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general/info	وضعPUT	إرسال معلومات الجهاز التي تم تحريرها إلى جهاز. يقتصر الإرسال على القيم التي تم تحريرها ضمن معلومات الجهاز الأساسية فقط وتُرسل في صورة بروتوكول إلى الجهاز.
getUpdatedGeneralInfoResult	/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}	الحصولGET	تلقّي معلومات الجهاز التي تم تحريرها من جهاز. تكون واجهة برمجة التطبيقات هذه قابلة للتنفيذ بعد تنفيذ خدمة تحديث المعلومات العامة.
moveDevice	/restapi/v1.0/rms/devices/{deviceId}/move	وضعPUT	نقل جهاز إلى مجموعة أخرى.
startRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/start	الحصولGET	إرسال بروتوكول بدء وضع إعادة التعيين إلى جهاز. يرسل جهاز تلقّى بروتوكول بدء وضع إعادة التعيين معلومات دوريّة عبر خادم جهاز التحكم عن بعد.
stopRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop	الحصولGET	إرسال بروتوكول إيقاف وضع إعادة التعيين إلى جهاز. يوقف جهاز تلقّى بروتوكول الإيقاف الوظيفة المطابقة في الحال.
getSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	الحصولGET	استيراد إعدادات الجهاز. يتم تحديث إعدادات الجهاز عند اتصال الجهاز بالخادم.
updateSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	وضعPUT	إرسال إعدادات الجهاز التي تم تحريرها إلى جهاز. يقتصر الإرسال على القيم التي تم تحريرها في الإعدادات فقط وتُرسل في صورة بروتوكول إلى الجهاز.
getUpdatedSetupInfoResult	/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}	الحصولGET	تلقّإعدادات معلومات الجهاز التي تم تحريرها من جهاز. تكون واجهة برمجة التطبيقات هذه قابلة للتنفيذ بعد تنفيذ خدمة تحديث معلومات الإعداد.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display	الحصولGET	إرسال طلب معلومات التحكّم في العرض الحالي إلى جهاز. في حالة استدعاء واجهة برمجة التطبيقات هذه، تكون النتيجة تلقّي معرّف الطلب كقيمة الاستجابة.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}	الحصولGET	استيراد معلومات التحكّم في العرض المُرسلة من جهاز. يُستخدم هذا الخيار لإجراءين اثنين: إرسال طلب الحصول على معلومات إلى جهاز وتلقّي معلومات الجهاز الفعلية.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time	الحصولGET	إرسال طلب معلومات الوقت الحالي إلى جهاز. في حالة استدعاء واجهة برمجة التطبيقات هذه، تكون النتيجة تلقّي معرّف الطلب كقيمة الاستجابة.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}	الحصولGET	استيراد معلومات الوقت المُرسلة من جهاز. يُستخدم هذا الخيار لإجراءين اثنين: إرسال طلب الحصول على معلومات إلى جهاز وتلقّي معلومات الجهاز الفعلية.
getTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	الحصولGET	استيراد معلومات وقت الجهاز من قاعدة البيانات. في حالة عدم وجود معلومات التحكم، يجب إرسال طلب الحصول على المعلومات إلى الجهاز.
updateTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	وضعPUT	إرسال معلومات الوقت التي تم تحريرها إلى جهاز. يقتصر الإرسال على القيم التي تم تحريرها ضمن معلومات الوقت فقط وتُرسل في صورة بروتوكول إلى الجهاز.
getUpdatedTimeInfoResult	/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}	الحصولGET	تلقّي معلومات وقت الجهاز التي تم تحريرها من جهاز. تكون واجهة برمجة التطبيقات هذه قابلة للتنفيذ بعد تنفيذ خدمة الحصول على نتيجة معلومات الوقت المحدّثة.
listDeviceGroupOrgan	/restapi/v1.0/rms/devices/groups	الحصولGET	استيراد قائمة التنظيمات.
listDeviceGroupInfo	/restapi/v1.0/rms/devices/groups/{groupId}	الحصولGET	استيراد تفاصيل المجموعة {groupId}.
listDeviceGroupChild	/restapi/v1.0/rms/devices/groups/{groupId}/child	الحصولGET	استيراد معلومات حول المجموعات الفرعية تحت {groupId}.

المستخدم

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

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

اسم الخدمة	استدعاء API	نوع الاستدعاء	الوصف
createUser	/restapi/v1.0/ums/users	نشرPOST	إضافة مستخدم.
listDashboardUserInfo	/restapi/v1.0/ums/users/dashboard	الحصولGET	استيراد معلومات المستخدم الضرورية من لوحة المعلومات.
updateMyInfo	/restapi/v1.0/ums/users/me	وضعPUT	تحرير معلومات المستخدم.
listUserOrgan	/restapi/v1.0/ums/users/organization	الحصولGET	استيراد قائمة التنظيمات. يمكن استخدام هذا الخيار لتكوين شجرة المجموعة.
listUserGroupOrgan	/restapi/v1.0/ums/users/groups	الحصولGET	استيراد قائمة التنظيمات.
listUserGroupInfo	/restapi/v1.0/ums/users/groups/{groupId}	الحصولGET	استيراد تفاصيل المجموعة {groupId}.
listUserGroupChild	/restapi/v1.0/ums/users/groups/{groupId}/child	الحصولGET	استيراد قائمة المجموعات الفرعية تحت المجموعة {groupId}.

الضبط

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

اسم الخدمة	استدعاء API	نوع الاستدعاء	الوصف
getCategoryInfo	/restapi/v1.0/ems/category/{categoryId}	الحصولGET	استيراد قائمة بالفئات.
deleteDashboard	/restapi/v1.0/ems/dashboard	حذفDELETE	حذف معلومات لوحة المعلومات المحددة.
listDashboardInfo	/restapi/v1.0/ems/dashboard	الحصولGET	استيراد المحتوى المطلوب عرضه على لوحة المعلومات المخصصة. من الممكن عرض المعلومات المحددة فقط على لوحة المعلومات.
updateDashboardPriority	/restapi/v1.0/ems/dashboard	وضعPUT	تغيير ترتيب العناصر المعروضة على لوحة المعلومات.
createDashboard	/restapi/v1.0/ems/dashboard/create	الحصولGET	تنشيط لوحة معلومات خاملة.
listDashboardLoginInfo	/restapi/v1.0/ems/dashboard/login	الحصولGET	استيراد معلومات تسجيل الدخول ليتم عرضها على لوحة المعلومات.
listDashboardNoticeInfo	/restapi/v1.0/ems/dashboard/notice	الحصولGET	استيراد معلومات لوحة النشرات ليتم عرضها على لوحة المعلومات.
deleteNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	حذفDELETE	حذف منشور من لوحة النشرات.
listEditNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	الحصولGET	استيراد تفاصيل المنشور المحدد.
createNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	نشرPOST	إضافة منشورات إلى لوحة النشرات.
updateNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	وضعPUT	تحرير المنشور المحدد على لوحة النشرات.
listDashboardStorageInfo	/restapi/v1.0/ems/dashboard/storage	الحصولGET	استيراد معلومات التخزين ليتم عرضها على لوحة المعلومات.
listLicense	/restapi/v1.0/ems/license	الحصولGET	استيراد قائمة التراخيص المسجلة على الخادم.
getServerSetupInfo	/restapi/v1.0/ems/setup	الحصولGET	استيراد إعدادات الخادم. تتضمن عناصر ضبط الخادم خيارات يمكنها تشغيل أو إيقاف تشغيل الوظائف المختلفة على الخادم.
getTagListInfo	/restapi/v1.0/ems/tag	نشرPOST	استيراد قائمة العلامات المسجلة على الخادم.

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

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

Sv translation

language	fr

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ête	Description
authenticationRequest	/auth	POST	Importe une valeur de jeton pour l’authentification à l’aide de l’identifiant d’utilisateur et du mot de passe.
authenticationRequest	/auth/refresh	GET	Cré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égorie	Contrôleur	Description
Contenu :	content-controller	Gestion du contenu
Contenu :	content-group-controller	Gestion du groupe de contenu
Liste de lecture	playlist-controller	Gestion des listes de lecture
Liste de lecture	playlist-group-controller	Gestion du groupe de listes de lecture
Programme	content-schedule-controller	Gestion du programme de contenu
	content-schedule-group-controller	Gestion du groupe de programmes de contenu
	message-schedule-controller	Gestion des programmes de messages
	message-schedule-group-controller	Gestion du groupe de programmes de message
Périphérique	device-controller	Gestion des périphériques
Périphérique	device-group-controller	Gestion du groupe de périphériques
Utilisateur	user-controller	Gestion des utilisateurs
Utilisateur	user-group-controller	Gestion du groupe d’utilisateurs
Réglage	environment-controller	Ré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ête	Description
listAllContent	/restapi/v1.0/cms/contents	GET	Permet 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	GET	Permet d’importer des informations de contenu générales à afficher sur le tableau de bord.
listContent	/restapi/v1.0/cms/contents/filter	POST	Permet 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}	DELETE	Supprime du contenu, que le contenu soit inclus ou non dans une liste de lecture ou un programme.
deleteContent	/restapi/v1.0/cms/contents/{contentId}	DELETE	Supprime 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}	GET	Permet 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	PUT	Permet 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}	POST	Permet de télécharger du nouveau contenu.
listDefaultGroup	/restapi/v1.0/cms/contents/groups	GET	Permet d’importer une liste des groupes de contenu par défaut.
getGroup	/restapi/v1.0/cms/contents/groups/{groupId}	GET	Permet d’importer les détails du groupe {groupId}.
listChildGroup	/restapi/v1.0/cms/contents/groups/{groupId}/child	GET	Permet 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ête	Description
listAllPlaylist	/restapi/v1.0/cms/playlists	GET	Permet 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	POST	Crée une nouvelle liste de lecture.
getDashboardPlaylistInfo	/restapi/v1.0/cms/playlists/dashboard	GET	Permet d’importer depuis le tableau de bord des informations de liste de lecture indispensables.
listPlaylist	/restapi/v1.0/cms/playlists/filter	POST	Permet 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}	DELETE	Supprime 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}	GET	Permet 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}	PUT	Modifie 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	PUT	Copie la liste de lecture {playlistId}. Un duplicata de la liste de lecture est créé.
listDefaultGroup	/restapi/v1.0/cms/playlists/groups	GET	Permet d’importer une liste des groupes de listes de lecture par défaut.
getGroup	/restapi/v1.0/cms/playlists/groups/{groupId}	GET	Permet d’importer les détails du groupe {groupId}.
listChildGroup	/restapi/v1.0/cms/playlists/groups/{groupId}/child	GET	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ête	Description
listContentScheduleAll	/restapi/v1.0/dms/schedule/contents	GET	Permet 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	POST	Permet 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	GET	Permet d’importer depuis le tableau de bord des informations de programme de contenu indispensables.
listContentScheduleByGroup	/restapi/v1.0/dms/schedule/contents/filter	POST	Permet 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}	DELETE	Supprime 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}	GET	Permet d’importer les détails du programme sélectionné.
editContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	PUT	Permet 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	PUT	Permet 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	PUT	Permet de publier un programme de contenu sur un groupe de périphériques spécifique.
getPublishStatus	/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus	GET	Permet 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	GET	Permet d’importer une liste de tous les groupes de racine pour un programme de contenu.
listContentScheduleGroupInfo	/restapi/v1.0/dms/schedule/contents/groups/{groupId}	GET	Permet d’importer les détails du groupe {groupId}.
listAllMessageSchedule	/restapi/v1.0/dms/schedule/messages	GET	Permet d’importer une liste de tous les programmes de message.
createMessageSchedule	/restapi/v1.0/dms/schedule/messages	POST	Permet 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}	DELETE	Supprime 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}	GET	Permet d’importer les détails du programme de message sélectionné.
editMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	PUT	Permet 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	PUT	Permet 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	PUT	Permet de publier le programme de message sélectionné sur un groupe de périphériques.
getRootGroups	/restapi/v1.0/dms/schedule/messages/groups	GET	Permet d’importer une liste de tous les groupes de racine pour un programme de contenu.
listMessageScheduleGroupInfo	/restapi/v1.0/dms/schedule/messages/groups/{groupId}	GET	Permet d’importer les détails du groupe {groupId}.
getChildGroups	/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child	GET	Permet 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ête	Description
listAllDevice	/restapi/v1.0/rms/devices	GET	Permet 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	GET	Permet d’importer depuis le tableau de bord des informations de périphérique indispensables.
filterDeviceList	/restapi/v1.0/rms/devices/filter	POST	Permet 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}	DELETE	Supprime le périphérique sélectionné.
getDevice	/restapi/v1.0/rms/devices/{deviceId}	GET	Permet d’importer les détails du périphérique sélectionné.
approveDevice	/restapi/v1.0/rms/devices/{deviceId}/approval	PUT	Permet d’approuver le périphérique sélectionné sur un groupe spécifique.
getCabinetList	/restapi/v1.0/rms/devices/{deviceId}/cabinet	POST	Permet 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	PUT	Permet de modifier des informations sur les cabinets connectés à un périphérique LED.
getDisplayControlInfo	/restapi/v1.0/rms/devices/{deviceId}/display	GET	Permet 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	PUT	Permet 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}	GET	Permet 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	GET	Permet 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	PUT	Permet 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}	GET	Permet 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	PUT	Permet de déplacer un périphérique sur un autre groupe.
startRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/start	GET	Permet 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	GET	Permet 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	GET	Permet 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	PUT	Permet 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}	GET	Permet 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	GET	Permet 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}	GET	Permet 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	GET	Permet 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}	GET	Permet 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	GET	Permet 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	PUT	Permet 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	GET	Permet d’importer une liste d’organisations.
listDeviceGroupInfo	/restapi/v1.0/rms/devices/groups/{groupId}	GET	Permet d’importer les détails du groupe {groupId}.
listDeviceGroupChild	/restapi/v1.0/rms/devices/groups/{groupId}/child	GET	Permet 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ête	Description
createUser	/restapi/v1.0/ums/users	POST	Permet d’ajouter un utilisateur.
listDashboardUserInfo	/restapi/v1.0/ums/users/dashboard	GET	Permet d’importer depuis le tableau de bord des informations d’utilisateur indispensables.
updateMyInfo	/restapi/v1.0/ums/users/me	PUT	Permet de modifier les informations relatives à l’utilisateur.
listUserOrgan	/restapi/v1.0/ums/users/organization	GET	Permet 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	GET	Permet d’importer une liste d’organisations.
listUserGroupInfo	/restapi/v1.0/ums/users/groups/{groupId}	GET	Permet d’importer les détails du groupe {groupId}.
listUserGroupChild	/restapi/v1.0/ums/users/groups/{groupId}/child	GET	Permet 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ête	Description
getCategoryInfo	/restapi/v1.0/ems/category/{categoryId}	GET	Permet d’importer une liste de catégories.
deleteDashboard	/restapi/v1.0/ems/dashboard	DELETE	Permet de supprimer des informations de tableau de bord spécifiques.
listDashboardInfo	/restapi/v1.0/ems/dashboard	GET	Permet 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	PUT	Permet de changer l’ordre des éléments affichés sur le tableau de bord.
createDashboard	/restapi/v1.0/ems/dashboard/create	GET	Permet d’activer un tableau de bord inactif.
listDashboardLoginInfo	/restapi/v1.0/ems/dashboard/login	GET	Permet d’importer des informations de connexion à afficher sur le tableau de bord.
listDashboardNoticeInfo	/restapi/v1.0/ems/dashboard/notice	GET	Permet d’importer des informations de tableau d’affichage à afficher sur le tableau de bord.
deleteNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	DELETE	Permet de supprimer une publication du tableau d’affichage.
listEditNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	GET	Permet d’importer les détails de la publication sélectionnée.
createNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	POST	Permet d’ajouter des publications au tableau d’affichage.
updateNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	PUT	Permet de modifier la publication sélectionnée sur le tableau d’affichage.
listDashboardStorageInfo	/restapi/v1.0/ems/dashboard/storage	GET	Permet d’importer des informations de stockage à afficher sur le tableau de bord.
listLicense	/restapi/v1.0/ems/license	GET	Permet d’importer une liste de licences enregistrées sur le serveur.
getServerSetupInfo	/restapi/v1.0/ems/setup	GET	Permet 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	POST	Permet 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

Sv translation

language	pt

O MagicINFO Server permite-lhe implementar funções de gestão do conteúdo, de gestão de agendamentos e de gestão de dispositivos, bem como outras funções, chamando a Open API (v2.0).

Para utilizar a Open API (v2.0), terá de passar primeiro por um processo de autenticação. Utilize uma página swagger separada para testar cada API.

Autenticação

Quando chamar todos os itens da Open API (v2.0), é necessário incluir api_token no cabeçalho. Se o cabeçalho não contiver esta expressão, será devolvido um erro "401 Não Autorizado".

Os tokens obtidos expiram e deixarão de estar disponíveis após um período específico. Se tal acontecer, deve obter um token novo.

Pode chamar a API que se segue para obter api_token.

Nome do serviço	Chamada API	Tipo de chamada	Descrição
authenticationRequest	/auth	POST	Permite importar o valor de um token para efeitos de autenticação através da ID e da palavra-passe de utilizador.
authenticationRequest	/auth/refresh	GET	Permite criar um token novo para adiar a hora da expiração. É possível chamar a API REST sem iniciar sessão novamente.

OPEN API (v2.0)

A Open API (v2.0) do MagicINFO Server disponibiliza várias funções. A configuração de cada função encontra-se apresentada abaixo.

Categoria	Controlador	Descrição
Conteúdo	content-controller	Gestão de ficheiros de conteúdo
Conteúdo	content-group-controller	Gestão de grupos de conteúdo
Lista de reprodução	playlist-controller	Gestão de listas de reprodução
Lista de reprodução	playlist-group-controller	Gestão de grupos de listas de reprodução
Programar	content-schedule-controller	Gestão de agendamentos de conteúdo
	content-schedule-group-controller	Gestão de grupos de agendamentos de conteúdo
	message-schedule-controller	Gestão de agendamentos de mensagens
	message-schedule-group-controller	Gestão de grupos de agendamentos de mensagens
Dispositivo	device-controller	Gestão de dispositivos
Dispositivo	device-group-controller	Gestão de grupos de dispositivos
Utilizador	user-controller	Gestão de utilizadores
Utilizador	user-group-controller	Gestão de grupos de utilizadores
Definição	environment-controller	Definição

Conteúdo

Pode carregar, aprovar e eliminar conteúdo. Também pode fazer a gestão de listas de conteúdo. Os serviços relativos a conteúdo estão acessíveis a utilizadores autenticados com privilégios de leitura, escrita e gestão de conteúdo.

Os serviços de gestão do conteúdo disponíveis são os seguintes:

Nome do serviço	Chamada API	Tipo de chamada	Descrição
listAllContent	/restapi/v1.0/cms/contents	GET	Permite importar uma lista de conteúdo carregado. A lista inclui miniaturas, nomes, tipos de ficheiro e outras informações básicas sobre o conteúdo. É possível importar as listas por página através das informações de paginação.
listDashboardContentInfo	/restapi/v1.0/cms/contents/dashboard	GET	Permite importar informações gerais sobre o conteúdo que será apresentado no painel de controlo.
listContent	/restapi/v1.0/cms/contents/filter	POST	Permite importar uma lista de conteúdo filtrado com base em condições. É possível importar as listas por página através das informações de paginação.
forceDeleteContent	/restapi/v1.0/cms/contents/force/{contentId}	DELETE	Permite eliminar conteúdo, quer o conteúdo esteja incluído numa lista de reprodução ou num agendamento ou não.
deleteContent	/restapi/v1.0/cms/contents/{contentId}	DELETE	Permite eliminar conteúdo após se verificar que o conteúdo não está incluído numa lista de reprodução nem num agendamento. Se tentar eliminar conteúdo incluído numa lista de reprodução ou agendamento, este não será eliminado. Além disso, será devolvido um código de erro.
getActiveContentInfo	/restapi/v1.0/cms/contents/{contentId}	GET	Permite importar detalhes sobre uma versão ativada de conteúdo. A versão do conteúdo é atualizada sempre que o conteúdo é editado.
approveContents	/restapi/v1.0/cms/contents/{contentId}/approval	PUT	Permite aprovar/rejeitar conteúdo. O conteúdo aprovado é movido para a lista de conteúdo geral e pode ser utilizado em listas de reprodução ou agendamentos.
uploadContent	/restapi/v1.0/cms/contents/{groupId}	POST	Permite carregar conteúdo novo.
listDefaultGroup	/restapi/v1.0/cms/contents/groups	GET	Permite importar uma lista de grupos de conteúdo predefinido.
getGroup	/restapi/v1.0/cms/contents/groups/{groupId}	GET	Permite importar detalhes do grupo {groupId}.
listChildGroup	/restapi/v1.0/cms/contents/groups/{groupId}/child	GET	Permite importar uma lista de subgrupos do grupo {groupId}.

Lista de reprodução

Pode utilizar conteúdo para criar, editar ou eliminar listas de reprodução. Os serviços relativos a listas de reprodução estão acessíveis a utilizadores autenticados com privilégios de leitura, escrita e gestão de conteúdo.

Os serviços de gestão de listas de reprodução disponíveis são os seguintes:

Nome do serviço	Chamada API	Tipo de chamada	Descrição
listAllPlaylist	/restapi/v1.0/cms/playlists	GET	Permite importar uma lista de todas as listas de reprodução. A lista inclui nomes de listas de reprodução, miniaturas do conteúdo principal, tipos de listas de reprodução e outras informações básicas. É possível importar as listas por página através das informações de paginação.
createPlaylist	/restapi/v1.0/cms/playlists	POST	Permite criar uma nova lista de reprodução.
getDashboardPlaylistInfo	/restapi/v1.0/cms/playlists/dashboard	GET	Permite importar informações necessárias sobre a lista de reprodução a partir do painel de controlo.
listPlaylist	/restapi/v1.0/cms/playlists/filter	POST	Permite importar uma lista de listas de reprodução filtradas com base em condições. É possível importar as listas por página através das informações de paginação.
deletePlaylist	/restapi/v1.0/cms/playlists/{playlistId}	DELETE	Permite eliminar a lista de reprodução selecionada. Se tentar eliminar uma lista de reprodução incluída num agendamento, esta não será eliminada. Além disso, será devolvido um código de erro.
getActivePlaylistInfo	/restapi/v1.0/cms/playlists/{playlistId}	GET	Permite importar detalhes sobre uma versão ativada de uma lista de reprodução. A versão da lista de reprodução é atualizada sempre que a lista de reprodução é editada.
editPlaylist	/restapi/v1.0/cms/playlists/{playlistId}	PUT	Permite editar a lista de reprodução {playlistId}. A edição de uma lista de reprodução atualiza a respetiva versão e faz com que o dispositivo que reproduz a lista de reprodução reproduza automaticamente a lista de reprodução atualizada.
copyPlaylist	/restapi/v1.0/cms/playlists/{playlistId}/copy	PUT	Permite copiar a lista de reprodução {playlistId}. É criada uma cópia duplicada da lista de reprodução.
listDefaultGroup	/restapi/v1.0/cms/playlists/groups	GET	Permite importar uma lista de grupos de listas de reprodução predefinidas.
getGroup	/restapi/v1.0/cms/playlists/groups/{groupId}	GET	Permite importar detalhes do grupo {groupId}.
listChildGroup	/restapi/v1.0/cms/playlists/groups/{groupId}/child	GET	Permite importar uma lista de subgrupos do grupo {groupId}.

Programar

Pode criar conteúdo ou agendamentos de mensagens novos. Também pode publicar agendamentos em dispositivos para reprodução, bem como editar ou eliminar agendamentos.

Os serviços relativos a agendamentos estão acessíveis a utilizadores autenticados com privilégios de leitura, escrita e gestão de agendamentos.

Os serviços de gestão de agendamentos disponíveis são os seguintes:

Nome do serviço	Chamada API	Tipo de chamada	Descrição
listContentScheduleAll	/restapi/v1.0/dms/schedule/contents	GET	Permite importar uma lista de todos os agendamentos de conteúdo. A lista inclui nomes de agendamentos de conteúdo, datas de criação, tipos de dispositivo e outras informações básicas. É possível importar as listas por página através das informações de paginação.
createContentSchedule	/restapi/v1.0/dms/schedule/contents	POST	Permite criar um novo agendamento de conteúdo. Um agendamento de conteúdo poderá conter vários canais e fotogramas. Permite publicar um agendamento em dispositivos e reproduzir o conteúdo ou a lista de reprodução pretendido a uma determinada hora.
listDashboardScheduleInfo	/restapi/v1.0/dms/schedule/contents/dashboard	GET	Permite importar informações necessárias sobre o agendamento de conteúdo a partir do painel de controlo.
listContentScheduleByGroup	/restapi/v1.0/dms/schedule/contents/filter	POST	Permite importar uma lista de agendamentos de conteúdo filtrados com base em diferentes condições. É possível importar as listas por página através das informações de paginação.
deleteContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	DELETE	Permite eliminar um agendamento de conteúdo. Se eliminar um agendamento previamente publicado num dispositivo, este último reproduz automaticamente o conteúdo predefinido.
getProgramInfo	/restapi/v1.0/dms/schedule/contents/{programId}	GET	Permite importar detalhes do agendamento selecionado.
editContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	PUT	Permite editar um agendamento de conteúdo. Se editar um agendamento previamente publicado num dispositivo, este último reproduz automaticamente o agendamento editado.
copyContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/copy	PUT	Permite copiar o agendamento de conteúdo {programId}. É criada uma cópia duplicada do agendamento de conteúdo {programId}.
deployContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/deploy	PUT	Permite publicar um agendamento de conteúdo num grupo de dispositivos específico.
getPublishStatus	/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus	GET	Permite importar o estado de transferência de agendamentos de conteúdo em tempo real a partir de um dispositivo.
getRootGroups	/restapi/v1.0/dms/schedule/contents/groups	GET	Permite importar uma lista de grupos de raiz para um agendamento de conteúdo.
listContentScheduleGroupInfo	/restapi/v1.0/dms/schedule/contents/groups/{groupId}	GET	Permite importar detalhes do grupo {groupId}.
listAllMessageSchedule	/restapi/v1.0/dms/schedule/messages	GET	Permite importar uma lista de todos os agendamentos de mensagens.
createMessageSchedule	/restapi/v1.0/dms/schedule/messages	POST	Permite criar um novo agendamento de mensagens.
listMessage	/restapi/v1.0/dms/schedule/messages/filter	POST	Permite importar uma lista de agendamentos de mensagens filtrados com base em diferentes condições. É possível importar as listas por página através das informações de paginação.
deleteMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	DELETE	Permite eliminar o agendamento de mensagens selecionado. Se eliminar um agendamento de mensagens previamente publicado num dispositivo, a alteração é automaticamente aplicada no dispositivo.
getMessageInfo	/restapi/v1.0/dms/schedule/messages/{messageId}	GET	Permite importar detalhes do agendamento de mensagens selecionado.
editMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	PUT	Permite editar o agendamento de mensagens selecionado. Se editar um agendamento de mensagens previamente publicado num dispositivo, a alteração é automaticamente aplicada no dispositivo.
copyMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/copy	PUT	Permite copiar o agendamento de mensagens selecionado. É criada uma cópia duplicada do agendamento de mensagens.
deployMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/deploy	PUT	Permite publicar o agendamento de mensagens selecionado num grupo de dispositivos.
getRootGroups	/restapi/v1.0/dms/schedule/messages/groups	GET	Permite importar uma lista de grupos de raiz para um agendamento de conteúdo.
listMessageScheduleGroupInfo	/restapi/v1.0/dms/schedule/messages/groups/{groupId}	GET	Permite importar detalhes do grupo {groupId}.
getChildGroups	/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child	GET	Permite importar uma lista de subgrupos de um grupo específico.

Dispositivo

Pode controlar e gerir dispositivos. Os serviços relativos a dispositivos estão acessíveis a utilizadores autenticados com privilégios de leitura, escrita e gestão de dispositivos.

Os serviços de gestão de dispositivos disponíveis são os seguintes:

Nome do serviço	Chamada API	Tipo de chamada	Descrição
listAllDevice	/restapi/v1.0/rms/devices	GET	Permite importar uma lista de todos os dispositivos. A lista inclui o estado da energia do dispositivo, informações sobre as miniaturas, o estado de erro do dispositivo e outras informações básicas. É possível importar as listas por página através das informações de paginação.
getDashboardDeviceInfo	/restapi/v1.0/rms/devices/dashboard	GET	Permite importar informações necessárias sobre o dispositivo a partir do painel de controlo.
filterDeviceList	/restapi/v1.0/rms/devices/filter	POST	Permite importar uma lista de dispositivos filtrados com base em diferentes condições. É possível importar as listas por página através das informações de paginação.
deleteDevice	/restapi/v1.0/rms/devices/{deviceId}	DELETE	Permite eliminar o dispositivo selecionado.
getDevice	/restapi/v1.0/rms/devices/{deviceId}	GET	Permite importar detalhes do dispositivo selecionado.
approveDevice	/restapi/v1.0/rms/devices/{deviceId}/approval	PUT	Permite aprovar o dispositivo selecionado para um grupo específico.
getCabinetList	/restapi/v1.0/rms/devices/{deviceId}/cabinet	POST	Permite importar informações sobre cabinets ligados a um dispositivo LED. As informações importadas só são válidas quando os cabinets estão ligados a um dispositivo LED.
updateCabinetInfo	/restapi/v1.0/rms/devices/{deviceId}/cabinet	PUT	Permite editar informações sobre cabinets ligados a um dispositivo LED.
getDisplayControlInfo	/restapi/v1.0/rms/devices/{deviceId}/display	GET	Permite importar informações de controlo de apresentação de dispositivos a partir da base de dados. Se não existirem informações de apresentação, deve enviar-se um pedido de informações para o dispositivo.
updateDisplayInfo	/restapi/v1.0/rms/devices/{deviceId}/display	PUT	Permite enviar informações de controlo de apresentação editadas para um dispositivo. Só os valores editados que se encontram nas informações de apresentação são enviados sob a forma de protocolo para o dispositivo.
getUpdatedDisplayInfoResult	/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}	GET	Permite receber informações de controlo de apresentação editadas de um dispositivo. Esta API é executável após a execução da API updateDisplayInfo.
getGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general	GET	Permite importar informações gerais de dispositivos a partir da base de dados. As informações gerais do dispositivo são atualizadas quando este se liga ao servidor.
updateGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general/info	PUT	Permite enviar informações de dispositivos editadas para um dispositivo. Só os valores editados que se encontram nas informações básicas de dispositivos são enviados sob a forma de protocolo para o dispositivo.
getUpdatedGeneralInfoResult	/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}	GET	Permite receber informações de dispositivos a partir de um dispositivo. Esta API é executável após a execução da API updateGeneralInfo.
moveDevice	/restapi/v1.0/rms/devices/{deviceId}/move	PUT	Permite mover um dispositivo para outro grupo.
startRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/start	GET	Permite enviar um protocolo de início RM para um dispositivo. Os dispositivos que receberam um protocolo de início RM enviam periodicamente informações através do Servidor do Controlo Remoto.
stopRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop	GET	Permite enviar um protocolo de paragem RM para um dispositivo. Os dispositivos que receberam um protocolo de paragem param imediatamente a função correspondente.
getSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	GET	Permite importar definições de dispositivos. As definições do dispositivo são atualizadas quando este se liga ao servidor.
updateSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	PUT	Permite enviar definições de dispositivos editadas para um dispositivo. Só os valores editados que se encontram nas definições são enviados sob a forma de protocolo para o dispositivo.
getUpdatedSetupInfoResult	/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}	GET	Permite receber definições de dispositivos a partir de um dispositivo. Esta API é executável após a execução da API updateSetupInfo.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display	GET	Permite enviar um pedido atual de informações de controlo de apresentação para um dispositivo. Se se chamar esta API, requestId é devolvido como o valor de resposta.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}	GET	Permite importar informações de controlo de apresentação enviadas a partir de um dispositivo. Esta opção é utilizada para duas ações: envio de um pedido de informações para um dispositivo e receção de informações reais do dispositivo.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time	GET	Permite enviar um pedido atual de informações de hora para um dispositivo. Se se chamar esta API, requestId é devolvido como o valor de resposta.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}	GET	Permite importar informações de hora enviadas a partir de um dispositivo. Esta opção é utilizada para duas ações: envio de um pedido de informações para um dispositivo e receção de informações reais do dispositivo.
getTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	GET	Permite importar informações de hora de dispositivos a partir da base de dados. Se não existirem informações de apresentação, deve enviar-se um pedido de informações para o dispositivo.
updateTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	PUT	Permite enviar informações de hora editadas para um dispositivo. Só os valores editados que se encontram nas informações de hora são enviados sob a forma de protocolo para o dispositivo.
getUpdatedTimeInfoResult	/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}	GET	Permite receber informações de hora de dispositivos a partir de um dispositivo. Esta API é executável após a execução da API getUpdatedTimeInfoResult.
listDeviceGroupOrgan	/restapi/v1.0/rms/devices/groups	GET	Permite importar uma lista de organizações.
listDeviceGroupInfo	/restapi/v1.0/rms/devices/groups/{groupId}	GET	Permite importar detalhes do grupo {groupId}.
listDeviceGroupChild	/restapi/v1.0/rms/devices/groups/{groupId}/child	GET	Permite importar informações sobre subgrupos de {groupId}.

Utilizador

Pode adicionar utilizadores e gerir informações dos mesmos. Os serviços relativos a utilizadores estão acessíveis a utilizadores autenticados com privilégios de leitura, escrita e gestão de informações de utilizadores.

Os serviços de gestão de utilizadores disponíveis são os seguintes:

Nome do serviço	Chamada API	Tipo de chamada	Descrição
createUser	/restapi/v1.0/ums/users	POST	Permite adicionar um utilizador.
listDashboardUserInfo	/restapi/v1.0/ums/users/dashboard	GET	Permite importar informações necessárias sobre utilizadores a partir do painel de controlo.
updateMyInfo	/restapi/v1.0/ums/users/me	PUT	Permite editar informações de utilizadores.
listUserOrgan	/restapi/v1.0/ums/users/organization	GET	Permite importar uma lista de organizações. Esta opção pode ser utilizada para configurar a árvore de um grupo.
listUserGroupOrgan	/restapi/v1.0/ums/users/groups	GET	Permite importar uma lista de organizações.
listUserGroupInfo	/restapi/v1.0/ums/users/groups/{groupId}	GET	Permite importar detalhes do grupo {groupId}.
listUserGroupChild	/restapi/v1.0/ums/users/groups/{groupId}/child	GET	Permite importar uma lista de subgrupos do grupo {groupId}.

Definição

Para além das funções principais, pode utilizar muitas outras funções para criar e gerir identificadores e categorias, bem como para editar o painel de controlo.

Nome do serviço	Chamada API	Tipo de chamada	Descrição
getCategoryInfo	/restapi/v1.0/ems/category/{categoryId}	GET	Permite importar uma lista de categorias.
deleteDashboard	/restapi/v1.0/ems/dashboard	DELETE	Permite eliminar informações de painel de controlo específicas.
listDashboardInfo	/restapi/v1.0/ems/dashboard	GET	Permite importar conteúdo que será apresentado no painel de controlo personalizado. Só é possível apresentar informações específicas no painel de controlo.
updateDashboardPriority	/restapi/v1.0/ems/dashboard	PUT	Permite alterar a ordem dos itens apresentados no painel de controlo.
createDashboard	/restapi/v1.0/ems/dashboard/create	GET	Permite ativar um painel de controlo inativo.
listDashboardLoginInfo	/restapi/v1.0/ems/dashboard/login	GET	Permite importar informações de início de sessão que serão apresentadas no painel de controlo.
listDashboardNoticeInfo	/restapi/v1.0/ems/dashboard/notice	GET	Permite importar informações de quadro de avisos que serão apresentadas no painel de controlo.
deleteNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	DELETE	Permite eliminar uma publicação de um quadro de avisos.
listEditNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	GET	Permite importar detalhes da publicação selecionada.
createNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	POST	Permite adicionar publicações ao quadro de avisos.
updateNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	PUT	Permite editar a publicação selecionada no quadro de avisos.
listDashboardStorageInfo	/restapi/v1.0/ems/dashboard/storage	GET	Permite importar informações de armazenamento que serão apresentadas no painel de controlo.
listLicense	/restapi/v1.0/ems/license	GET	Permite importar uma lista de licenças registadas no servidor.
getServerSetupInfo	/restapi/v1.0/ems/setup	GET	Permite importar definições do servidor. Os itens das definições do servidor incluem opções que podem ativar ou desativar as diferentes funções no servidor.
getTagListInfo	/restapi/v1.0/ems/tag	POST	Permite importar uma lista de identificadores registados no servidor.

Detalhes da Open API (IU swagger)

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

Sv translation

language	ru

MagicINFO Server позволяет реализовать управление содержимым, расписаниями, устройствами, а также другие функции с помощью вызова методов Open API (v2.0).

Для того, чтобы использовать Open API (v2.0), сперва нужно пройти процедуру аутентификации. Используйте отдельную swagger-страницу для проверки каждого API.

Проверка подлинности

При вызове объектов Open API (v2.0) необходимо включить в заголовок api_token. В противном случае появится ошибка "401 Нет доступа".

Маркер доступа становится недоступным для использования по истечении срока действия. В этом случае необходимо получить новый маркер доступа.

Получить маркер доступа api_token можно путем вызова следующего api.

Название услуги	Вызов API	Тип вызова	Описание
Запрос «Аутентификация»	/auth	POST (создание)	Импорт значения маркера доступа для аутентификации с использованием ИД и пароля пользователя.
Запрос «Аутентификация»	/auth/refresh	GET (чтение)	Создание нового маркера доступа для продления срока действия. Вызов REST API можно осуществлять без повторного входа в систему.

OPEN API (v2.0)

MagicINFO Server Open API (v2.0) предлагает множество функций. Конфигурация каждой функции представлена ниже.

Категория	Контроллер	Описание
Содержимое	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	GET (чтение)	Импорт списка всего загруженного содержимого. Список содержит эскизы, имена, типы файлов и другие основные сведения. Загружать списки можно постранично, используя постраничную информацию.
listDashboardContentInfo	/restapi/v1.0/cms/contents/dashboard	GET (чтение)	Импорт общих сведений о содержимом, отображаемом на панели управления.
listContent	/restapi/v1.0/cms/contents/filter	POST (создание)	Импорт списка содержимого, отсортированного по параметрам. Загружать списки можно постранично, используя постраничную информацию.
forceDeleteContent	/restapi/v1.0/cms/contents/force/{contentId}	DELETE (удалить)	Удаление содержимого вне зависимости, включено оно в список воспроизведения или расписание.
deleteContent	/restapi/v1.0/cms/contents/{contentId}	DELETE (удалить)	Удаление содержимого после проверки его содержания в списке воспроизведения или расписании. Если содержимое включено в список воспроизведения или расписание, то при попытке его удаления отобразится код ошибки.
getActiveContentInfo	/restapi/v1.0/cms/contents/{contentId}	GET (чтение)	Импорт подробных сведений об активированной версии списка содержимого. Версия списка содержимого обновляется каждый раз при его изменении.
approveContents	/restapi/v1.0/cms/contents/{contentId}/approval	PUT (заполнение)	Подтверждение/отклонение содержимого. Подтвержденное содержимое перемещается в общий список и может использоваться в списках воспроизведения или расписаниях.
uploadContent	/restapi/v1.0/cms/contents/{groupId}	POST (создание)	Загрузка нового содержимого.
listDefaultGroup	/restapi/v1.0/cms/contents/groups	GET (чтение)	Импорт перечня групп содержимого по умолчанию.
getGroup	/restapi/v1.0/cms/contents/groups/{groupId}	GET (чтение)	Импорт подробных сведений о {groupId} группе.
listChildGroup	/restapi/v1.0/cms/contents/groups/{groupId}/child	GET (чтение)	Импорт списка подгрупп под указанной {groupId} группой.

Плейлист

Используйте содержимое для создания, изменения или удаления списков воспроизведения. Службы для работы со списками воспроизведения доступны для авторизованных пользователей, обладающих правами на чтение, запись и управление содержимым.

Ниже приведены доступные службы управления списками воспроизведения:

Название услуги	Вызов API	Тип вызова	Описание
listAllPlaylist	/restapi/v1.0/cms/playlists	GET (чтение)	Импорт перечня всех списков воспроизведения. Перечень содержит имена списков воспроизведения, эскизы основного содержимого, типы списков воспроизведения и другие основные сведения. Загружать списки можно постранично, используя постраничную информацию.
createPlaylist	/restapi/v1.0/cms/playlists	POST (создание)	Создание нового списка воспроизведения.
getDashboardPlaylistInfo	/restapi/v1.0/cms/playlists/dashboard	GET (чтение)	Импорт необходимых сведений о списке воспроизведения с приборной панели.
listPlaylist	/restapi/v1.0/cms/playlists/filter	POST (создание)	Импорт перечня списков воспроизведения, отсортированных по параметрам. Загружать списки можно постранично, используя постраничную информацию.
deletePlaylist	/restapi/v1.0/cms/playlists/{playlistId}	DELETE (удалить)	удаление выбранного списка воспроизведения. Если список воспроизведения включен в расписание, то при попытке его удаления отобразится код ошибки.
getActivePlaylistInfo	/restapi/v1.0/cms/playlists/{playlistId}	GET (чтение)	Импорт подробных сведений об активированной версии списка воспроизведения. Версия списка воспроизведения обновляется каждый раз при его изменении.
editPlaylist	/restapi/v1.0/cms/playlists/{playlistId}	PUT (заполнение)	Изменение {playlistId} списка воспроизведения. При изменении списка воспроизведения его версия обновляется, таким образом устройство автоматически проигрывает обновленный список воспроизведения.
copyPlaylist	/restapi/v1.0/cms/playlists/{playlistId}/copy	PUT (заполнение)	Копирование {playlistId} списка воспроизведения. Создается дубликат списка воспроизведения.
listDefaultGroup	/restapi/v1.0/cms/playlists/groups	GET (чтение)	Импорт перечня групп списков воспроизведения по умолчанию.
getGroup	/restapi/v1.0/cms/playlists/groups/{groupId}	GET (чтение)	Импорт подробных сведений о {groupId} группе.
listChildGroup	/restapi/v1.0/cms/playlists/groups/{groupId}/child	GET (чтение)	Импорт списка подгрупп под указанной {groupId} группой.

Расписание

Создание нового содержимого или расписания сообщений. Публикация расписания для воспроизведения на устройствах. Изменение или удаление расписаний.

Службы для работы с расписаниями доступны для авторизованных пользователей, обладающих правами на чтение, запись и управление расписаниями.

Ниже приведены доступные службы управления расписаниями:

Название услуги	Вызов API	Тип вызова	Описание
listContentScheduleAll	/restapi/v1.0/dms/schedule/contents	GET (чтение)	Импорт перечня всех расписаний содержимого. Перечень содержит имена расписаний содержимого, даты создания, типы устройств и другие основные сведения. Загружать списки можно постранично, используя постраничную информацию.
createContentSchedule	/restapi/v1.0/dms/schedule/contents	POST (создание)	Создание нового расписания содержимого. Расписание содержимого может содержать несколько каналов и кадров. Публикация расписания на устройствах и воспроизведение нужного содержимого или списка воспроизведения в указанное время.
listDashboardScheduleInfo	/restapi/v1.0/dms/schedule/contents/dashboard	GET (чтение)	Импорт необходимых сведений о расписании содержимого с приборной панели.
listContentScheduleByGroup	/restapi/v1.0/dms/schedule/contents/filter	POST (создание)	Импорт списка расписаний содержимого, отсортированных по различным параметрам. Загружать списки можно постранично, используя постраничную информацию.
deleteContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	DELETE (удалить)	Удаление расписания содержимого. При удалении расписания, ранее опубликованного на устройстве, автоматически выполняется воспроизведение содержимого по умолчанию.
getProgramInfo	/restapi/v1.0/dms/schedule/contents/{programId}	GET (чтение)	Импорт подробных сведений о выбранном расписании.
editContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	PUT (заполнение)	Изменение расписания файла содержимого. При изменении расписания, ранее опубликованного на устройстве, автоматически выполняется воспроизведение отредактированного расписания.
copyContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/copy	PUT (заполнение)	Копирование {programId} расписания содержимого. Создается дубликат расписания содержимого {programId}.
deployContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/deploy	PUT (заполнение)	Публикация расписания содержимого в указанной группе устройств.
getPublishStatus	/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus	GET (чтение)	Импорт состояния загрузки расписания содержимого в режиме реального времени с устройства.
getRootGroups	/restapi/v1.0/dms/schedule/contents/groups	GET (чтение)	Импорт списка исходных групп для расписания содержимого.
listContentScheduleGroupInfo	/restapi/v1.0/dms/schedule/contents/groups/{groupId}	GET (чтение)	Импорт подробных сведений о {groupId} группе.
listAllMessageSchedule	/restapi/v1.0/dms/schedule/messages	GET (чтение)	Импорт списка всех расписаний сообщений.
createMessageSchedule	/restapi/v1.0/dms/schedule/messages	POST (создание)	Создание нового расписания сообщений.
listMessage	/restapi/v1.0/dms/schedule/messages/filter	POST (создание)	Импорт списка расписаний сообщений, отсортированных по различным параметрам. Загружать списки можно постранично, используя постраничную информацию.
deleteMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	DELETE (удалить)	Удаление выбранного расписания сообщений. При удалении расписания сообщений, ранее опубликованного на устройстве, внесенные изменения применяются автоматически.
getMessageInfo	/restapi/v1.0/dms/schedule/messages/{messageId}	GET (чтение)	Импорт подробных сведений о выбранном расписании сообщений.
editMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	PUT (заполнение)	Изменение выбранного расписания сообщений. При изменении расписания сообщений, ранее опубликованного на устройстве, внесенные изменения применяются автоматически.
copyMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/copy	PUT (заполнение)	Копирование выбранного расписания сообщений. Создается дубликат расписания сообщений.
deployMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/deploy	PUT (заполнение)	Публикация выбранного расписания сообщений в группе устройств.
getRootGroups	/restapi/v1.0/dms/schedule/messages/groups	GET (чтение)	Импорт списка исходных групп для расписания содержимого.
listMessageScheduleGroupInfo	/restapi/v1.0/dms/schedule/messages/groups/{groupId}	GET (чтение)	Импорт подробных сведений о {groupId} группе.
getChildGroups	/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child	GET (чтение)	Импорт списка подгрупп под указанной группой.

Устройство

Контроль и управление устройствами. Службы по работе с устройствами доступны для авторизованных пользователей, обладающих правами на чтение, запись и управление устройствами.

Ниже приведены доступные службы управления устройствами:

Название услуги	Вызов API	Тип вызова	Описание
listAllDevice	/restapi/v1.0/rms/devices	GET (чтение)	Импорт списка всех устройств. Список содержит состояние питания устройства, информацию об эскизе, статусы ошибок устройства и другие основные сведения. Загружать списки можно постранично, используя постраничную информацию.
getDashboardDeviceInfo	/restapi/v1.0/rms/devices/dashboard	GET (чтение)	Импорт необходимых сведений об устройстве с приборной панели.
filterDeviceList	/restapi/v1.0/rms/devices/filter	POST (создание)	Импорт списка устройств, отсортированных по различным параметрам. Загружать списки можно постранично, используя постраничную информацию.
deleteDevice	/restapi/v1.0/rms/devices/{deviceId}	DELETE (удалить)	удаление выбранного устройства.
getDevice	/restapi/v1.0/rms/devices/{deviceId}	GET (чтение)	Импорт подробных сведений о выбранном устройстве.
approveDevice	/restapi/v1.0/rms/devices/{deviceId}/approval	PUT (заполнение)	Подтверждение выбранного устройства в указанной группе.
getCabinetList	/restapi/v1.0/rms/devices/{deviceId}/cabinet	POST (создание)	Импорт сведений о блоках, подключенных к светодиодному устройству. Полученные сведения действительны только при условии подключения блоков к светодиодному устройству.
updateCabinetInfo	/restapi/v1.0/rms/devices/{deviceId}/cabinet	PUT (заполнение)	Изменение сведений о блоках, подключенных к светодиодному устройству.
getDisplayControlInfo	/restapi/v1.0/rms/devices/{deviceId}/display	GET (чтение)	Импорт сведений об управлении экраном устройства из базы данных. В случае отсутствия сведений об управлении, запрос на их получение отправляется в устройство.
updateDisplayInfo	/restapi/v1.0/rms/devices/{deviceId}/display	PUT (заполнение)	Отправка отредактированной информации об управлении экраном на устройство. Сведения об экране, отправленные в виде протокола, будут содержать только отредактированные значения.
getUpdatedDisplayInfoResult	/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}	GET (чтение)	Получение отредактированной информации об управлении экраном из устройства. Выполнение этого запроса API возможно после завершения запроса updateDisplayInfo API.
getGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general	GET (чтение)	Импорт общих сведений об устройстве из базы данных. Общие сведения устройства обновляются при его подключении к серверу.
updateGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general/info	PUT (заполнение)	Отправка отредактированной информации на устройство. Общие сведения об устройстве, отправленные в виде протокола, будут содержать только отредактированные значения.
getUpdatedGeneralInfoResult	/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}	GET (чтение)	Получение отредактированной информации об устройстве. Выполнение этого запроса API возможно после завершения запроса updateGeneralInfo API.
moveDevice	/restapi/v1.0/rms/devices/{deviceId}/move	PUT (заполнение)	Перемещение устройства в другую группу.
startRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/start	GET (чтение)	Отправка протокола запуска RM на устройство. С устройства, на которое принят стартовый протокол RM, периодически отправляются сведения через сервер дистанционного управления.
stopRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop	GET (чтение)	Отправка протокола остановки RM на устройство. Устройство незамедлительно останавливает выполнение соответствующей функции при получении протокола с остановкой.
getSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	GET (чтение)	Импорт параметров устройства. Параметры устройства обновляются при его подключении к серверу.
updateSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	PUT (заполнение)	Отправка измененных параметров на устройство. Настройки, отправленные в виде протокола, будут содержать только отредактированные значения.
getUpdatedSetupInfoResult	/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}	GET (чтение)	Получение измененных параметров от устройство. Выполнение этого запроса API возможно после завершения запроса updateSetupInfo API.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display	GET (чтение)	Отправка запроса текущей информации об управлении экраном на устройство. При вызове этого API запрос отображается в виде ответного значения.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}	GET (чтение)	Импорт информации об управлении экраном, отправленной с устройства. Эта опция используется для выполнения двух действий: отправка запроса информации на устройство и получение информации о нем.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time	GET (чтение)	Отправка запроса информации о текущем времени на устройство. При вызове этого API запрос отображается в виде ответного значения.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}	GET (чтение)	Импорт информации о времени экраном, отправленной с устройства. Эта опция используется для выполнения двух действий: отправка запроса информации на устройство и получение информации о нем.
getTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	GET (чтение)	Импорт информации о времени устройства из базы данных. В случае отсутствия сведений об управлении, запрос на их получение отправляется в устройство.
updateTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	PUT (заполнение)	Отправка отредактированной информации о времени на устройство. Сведения об времени, отправленные в виде протокола, будут содержать только отредактированные значения.
getUpdatedTimeInfoResult	/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}	GET (чтение)	Получение отредактированной информации о времени от устройства. Выполнение этого запроса API возможно после завершения запроса getUpdatedTimeInfoResult API.
listDeviceGroupOrgan	/restapi/v1.0/rms/devices/groups	GET (чтение)	Импорт списка организаций.
listDeviceGroupInfo	/restapi/v1.0/rms/devices/groups/{groupId}	GET (чтение)	Импорт подробных сведений о {groupId} группе.
listDeviceGroupChild	/restapi/v1.0/rms/devices/groups/{groupId}/child	GET (чтение)	Импорт информации о подгруппах ниже {groupId}.

Пользователь

Добавляйте пользователей и управляйте информацией о них. Службы для работы с пользователями доступны для авторизованных пользователей, обладающих правами на чтение, запись и управление информацией о пользователях.

Ниже приведены доступные службы управления пользователями:

Название услуги	Вызов API	Тип вызова	Описание
createUser	/restapi/v1.0/ums/users	POST (создание)	Добавление пользователя.
listDashboardUserInfo	/restapi/v1.0/ums/users/dashboard	GET (чтение)	Импорт необходимых сведений о пользователях с панели управления.
updateMyInfo	/restapi/v1.0/ums/users/me	PUT (заполнение)	Редактирование сведений о пользователях.
listUserOrgan	/restapi/v1.0/ums/users/organization	GET (чтение)	Импорт списка организаций. Данная опция используется для настройки дерева групп.
listUserGroupOrgan	/restapi/v1.0/ums/users/groups	GET (чтение)	Импорт списка организаций.
listUserGroupInfo	/restapi/v1.0/ums/users/groups/{groupId}	GET (чтение)	Импорт подробных сведений о {groupId} группе.
listUserGroupChild	/restapi/v1.0/ums/users/groups/{groupId}/child	GET (чтение)	Импорт списка подгрупп под указанной {groupId} группой.

Настройка

В дополнение к основным функциям можно использовать множество других функций для создания и управления метками и категориями, а также изменения панели управления.

Название услуги	Вызов API	Тип вызова	Описание
getCategoryInfo	/restapi/v1.0/ems/category/{categoryId}	GET (чтение)	Импорт списка категорий.
deleteDashboard	/restapi/v1.0/ems/dashboard	DELETE (удалить)	Удаление определенной информации о панели управления.
listDashboardInfo	/restapi/v1.0/ems/dashboard	GET (чтение)	Импорт содержимого, отображаемого на пользовательской панели управления. Можно настраивать отображение только указанной информации на панели управления.
updateDashboardPriority	/restapi/v1.0/ems/dashboard	PUT (заполнение)	Изменение порядка отображения объектов на панели управления.
createDashboard	/restapi/v1.0/ems/dashboard/create	GET (чтение)	Активация резервной панели управления.
listDashboardLoginInfo	/restapi/v1.0/ems/dashboard/login	GET (чтение)	Импорт учетных данных, отображаемых на панели управления.
listDashboardNoticeInfo	/restapi/v1.0/ems/dashboard/notice	GET (чтение)	Импорт информации с доски объявлений, отображаемой на панели управления.
deleteNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	DELETE (удалить)	Удаление публикации из доски объявлений.
listEditNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	GET (чтение)	Импорт подробных сведений о выбранной публикации.
createNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	POST (создание)	Размещение публикаций на доске объявлений.
updateNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	PUT (заполнение)	Изменение выбранной публикации на доске объявлений.
listDashboardStorageInfo	/restapi/v1.0/ems/dashboard/storage	GET (чтение)	Импорт информации об объеме памяти, отображаемой на панели управления.
listLicense	/restapi/v1.0/ems/license	GET (чтение)	Импорт списка лицензий, зарегистрированных на сервере.
getServerSetupInfo	/restapi/v1.0/ems/setup	GET (чтение)	Импорт параметров сервера. Элементы настройки сервера включают опции, с помощью которых включаются или отключаются различные функции на сервере.
getTagListInfo	/restapi/v1.0/ems/tag	POST (создание)	Импорт списка меток, зарегистрированных на сервере.

Открытие подробных сведений API (swagger UI)

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

Sv translation

language	zh_CN

MagicINFO Server 可让您通过调用 Open API（2.0 版）实现内容管理、日程表管理、设备管理和其他功能。

要使用 Open API（2.0 版），您首选需要通过验证流程。使用单独的 swagger 页面测试每个 API。

身份验证

调用所有 Open API（2.0 版）项目时，必须在标头中包含 api_token。如果未包含此项，将返回“401 未授权”错误。

经过指定的时间段后，获得的令牌过期并且变为不可用。如果是这种情况，应获得新令牌。

通过调用以下 api 可获得 api_token。

服务名称	API 调用	调用类别	说明
authenticationRequest	/auth	POST	使用用户 ID 和密码导入令牌值以进行验证。
authenticationRequest	/auth/refresh	GET	创建新令牌以延长过期时间。可以调用 REST API 而无需再次登录

OPEN API（2.0 版）

MagicINFO Server Open API（2.0 版）提供各种功能。每种功能的配置如下所示。

类别	控制器	说明
内容	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	GET	导入已上传内容的列表。内容缩略图、名称、文件类型和其他基本信息均包含在该列表中。列表可以使用分页信息每页导入。
listDashboardContentInfo	/restapi/v1.0/cms/contents/dashboard	GET	导入要在仪表板上显示的常规内容信息。
listContent	/restapi/v1.0/cms/contents/filter	POST	导入基于条件筛选的内容列表。列表可以使用分页信息每页导入。
forceDeleteContent	/restapi/v1.0/cms/contents/force/{contentId}	DELETE	删除内容，无论内容是否包含在播放列表或日程表中。
deleteContent	/restapi/v1.0/cms/contents/{contentId}	DELETE	检查内容未包含在播放列表或日程表中后删除内容。如果尝试删除包含在播放列表或日程表中的内容，将不会删除该内容，并且将返回错误代码。
getActiveContentInfo	/restapi/v1.0/cms/contents/{contentId}	GET	导入激活内容版本的详细信息。每次编辑内容时都会更新内容版本。
approveContents	/restapi/v1.0/cms/contents/{contentId}/approval	PUT	批准/拒绝内容。批准的内容将移动到常规内容列表，并可在播放列表或日程表中使用。
uploadContent	/restapi/v1.0/cms/contents/{groupId}	POST	上传新内容。
listDefaultGroup	/restapi/v1.0/cms/contents/groups	GET	导入默认内容组的列表。
getGroup	/restapi/v1.0/cms/contents/groups/{groupId}	GET	导入 {groupId} 组的详细信息。
listChildGroup	/restapi/v1.0/cms/contents/groups/{groupId}/child	GET	导入 {groupId} 组下子组的列表。

播放列表

使用内容创建、编辑或删除播放列表。具有读取、写入和管理内容权限的经验证用户可以访问播放列表相关服务。

可用的播放列表管理服务如下：

服务名称	API 调用	调用类别	说明
listAllPlaylist	/restapi/v1.0/cms/playlists	GET	导入所有播放列表的列表。播放列表名称、主要内容缩略图、播放列表类型和其他基本信息均包含在该列表中。列表可以使用分页信息每页导入。
createPlaylist	/restapi/v1.0/cms/playlists	POST	创建新播放列表。
getDashboardPlaylistInfo	/restapi/v1.0/cms/playlists/dashboard	GET	从仪表板导入必要的播放列表信息。
listPlaylist	/restapi/v1.0/cms/playlists/filter	POST	导入基于条件筛选的播放列表的列表。列表可以使用分页信息每页导入。
deletePlaylist	/restapi/v1.0/cms/playlists/{playlistId}	DELETE	删除所选播放列表。如果尝试删除包含在日程表中的播放列表，将不会删除该播放列表，并且将返回错误代码。
getActivePlaylistInfo	/restapi/v1.0/cms/playlists/{playlistId}	GET	导入激活播放列表版本的详细信息。每次编辑播放列表时都会更新播放列表版本。
editPlaylist	/restapi/v1.0/cms/playlists/{playlistId}	PUT	编辑 {playlistId} 播放列表。编辑播放列表会更新播放列表版本，并使播放该播放列表的设备自动播放更新的播放列表。
copyPlaylist	/restapi/v1.0/cms/playlists/{playlistId}/copy	PUT	复制 {playlistId} 播放列表。创建播放列表的复制副本。
listDefaultGroup	/restapi/v1.0/cms/playlists/groups	GET	导入默认播放列表组的列表。
getGroup	/restapi/v1.0/cms/playlists/groups/{groupId}	GET	导入 {groupId} 组的详细信息。
listChildGroup	/restapi/v1.0/cms/playlists/groups/{groupId}/child	GET	导入 {groupId} 组下子组的列表。

日程表

创建新的内容或消息日程表。将日程表发布到设备以进行播放。编辑或删除日程表。

具有读取、写入和管理日程表权限的经验证用户可以访问日程表相关服务。

可用的日程表管理服务如下：

服务名称	API 调用	调用类别	说明
listContentScheduleAll	/restapi/v1.0/dms/schedule/contents	GET	导入所有内容日程表的列表。内容日程表名称、创建日期、设备类型和其他基本信息均包含在该列表中。列表可以使用分页信息每页导入。
createContentSchedule	/restapi/v1.0/dms/schedule/contents	POST	创建新的内容日程表。内容日程表可能包含多个频道和框架。将日程表发布到设备并在指定的时间播放所需内容或播放列表。
listDashboardScheduleInfo	/restapi/v1.0/dms/schedule/contents/dashboard	GET	从仪表板导入必要的内容日程表信息。
listContentScheduleByGroup	/restapi/v1.0/dms/schedule/contents/filter	POST	导入基于不同条件筛选的内容日程表列表。列表可以使用分页信息每页导入。
deleteContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	DELETE	删除内容日程表。如果删除以前发布到设备的日程表，设备会自动播放默认内容。
getProgramInfo	/restapi/v1.0/dms/schedule/contents/{programId}	GET	导入所选日程表的详细信息。
editContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	PUT	编辑内容日程表。如果编辑以前发布到设备的日程表，设备会自动播放编辑的日程表。
copyContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/copy	PUT	复制 {programId} 内容日程表。创建 {programId} 内容日程表的复制副本。
deployContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/deploy	PUT	将内容日程表发布到特定的设备组。
getPublishStatus	/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus	GET	从设备导入实时内容日程表下载状态。
getRootGroups	/restapi/v1.0/dms/schedule/contents/groups	GET	导入内容日程表根组的列表。
listContentScheduleGroupInfo	/restapi/v1.0/dms/schedule/contents/groups/{groupId}	GET	导入 {groupId} 组的详细信息。
listAllMessageSchedule	/restapi/v1.0/dms/schedule/messages	GET	导入所有消息日程表的列表。
createMessageSchedule	/restapi/v1.0/dms/schedule/messages	POST	创建新的消息日程表。
listMessage	/restapi/v1.0/dms/schedule/messages/filter	POST	导入基于不同条件筛选的消息日程表列表。列表可以使用分页信息每页导入。
deleteMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	DELETE	删除所选消息日程表。如果删除以前发布到设备的消息日程表，更改会自动应用到设备。
getMessageInfo	/restapi/v1.0/dms/schedule/messages/{messageId}	GET	导入所选消息日程表的详细信息。
editMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	PUT	编辑所选消息日程表。如果编辑以前发布到设备的消息日程表，更改会自动应用到设备。
copyMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/copy	PUT	复制所选消息日程表。创建消息日程表的复制副本。
deployMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/deploy	PUT	将所选消息日程表发布到设备组。
getRootGroups	/restapi/v1.0/dms/schedule/messages/groups	GET	导入内容日程表根组的列表。
listMessageScheduleGroupInfo	/restapi/v1.0/dms/schedule/messages/groups/{groupId}	GET	导入 {groupId} 组的详细信息。
getChildGroups	/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child	GET	导入特定组下子组的列表。

设备

控制和管理设备。具有读取、写入和管理设备权限的经验证用户可以访问设备相关服务。

可用的设备管理服务如下：

服务名称	API 调用	调用类别	说明
listAllDevice	/restapi/v1.0/rms/devices	GET	导入所有设备的列表。设备电源状态、缩略图信息、设备错误状态和其他基本信息均包含在该列表中。列表可以使用分页信息每页导入。
getDashboardDeviceInfo	/restapi/v1.0/rms/devices/dashboard	GET	从仪表板导入必要的设备信息。
filterDeviceList	/restapi/v1.0/rms/devices/filter	POST	导入基于不同条件筛选的设备列表。列表可以使用分页信息每页导入。
deleteDevice	/restapi/v1.0/rms/devices/{deviceId}	DELETE	删除所选的设备。
getDevice	/restapi/v1.0/rms/devices/{deviceId}	GET	导入所选设备的详细信息。
approveDevice	/restapi/v1.0/rms/devices/{deviceId}/approval	PUT	批准所选设备到特定组。
getCabinetList	/restapi/v1.0/rms/devices/{deviceId}/cabinet	POST	导入连接到 LED 设备的机柜的相关信息。导入的信息仅当机柜连接到 LED 设备时有效。
updateCabinetInfo	/restapi/v1.0/rms/devices/{deviceId}/cabinet	PUT	编辑连接到 LED 设备的机柜的相关信息。
getDisplayControlInfo	/restapi/v1.0/rms/devices/{deviceId}/display	GET	从数据库导入设备显示屏控制信息。如果控制信息不存在，则信息请求应发送到设备。
updateDisplayInfo	/restapi/v1.0/rms/devices/{deviceId}/display	PUT	将编辑的显示屏控制信息发送到设备。只有显示屏信息中编辑的值作为协议发送到设备。
getUpdatedDisplayInfoResult	/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}	GET	从设备接收编辑的显示屏控制信息。此 API 在执行 updateDisplayInfo API 后可执行。
getGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general	GET	从数据库导入常规设备信息。设备连接到服务器时会更新常规设备信息。
updateGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general/info	PUT	将编辑的设备信息发送到设备。只有基本设备信息中编辑的值作为协议发送到设备。
getUpdatedGeneralInfoResult	/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}	GET	从设备接收编辑的设备信息。此 API 在执行 updateGeneralInfo API 后可执行。
moveDevice	/restapi/v1.0/rms/devices/{deviceId}/move	PUT	将设备移动到另一个组。
startRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/start	GET	将 RM 启动协议发送到设备。接收 RM 启动协议的设备会通过远程控制服务器定期发送信息。
stopRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop	GET	将 RM 停止协议发送到设备。接收停止协议的设备会立即停止相应的功能。
getSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	GET	导入设备设置。设备连接到服务器时会更新设备设置。
updateSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	PUT	将编辑的设备设置发送到设备。只有设置中编辑的值作为协议发送到设备。
getUpdatedSetupInfoResult	/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}	GET	从设备接收编辑的设备设置。此 API 在执行 updateSetupInfo API 后可执行。
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display	GET	将当前显示屏控制信息请求发送到设备。如果调用此 API，requestId 将作为响应值返回。
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}	GET	导入从设备发送的显示屏控制信息。此选项用于两个操作：将信息请求发送到设备和接收实际设备信息。
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time	GET	将当前时间信息请求发送到设备。如果调用此 API，requestId 将作为响应值返回。
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}	GET	导入从设备发送的时间信息。此选项用于两个操作：将信息请求发送到设备和接收实际设备信息。
getTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	GET	从数据库导入设备时间信息。如果控制信息不存在，则信息请求应发送到设备。
updateTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	PUT	将编辑的时间信息发送到设备。只有时间信息中编辑的值作为协议发送到设备。
getUpdatedTimeInfoResult	/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}	GET	从设备接收编辑的设备时间信息。此 API 在执行 getUpdatedTimeInfoResult API 后可执行。
listDeviceGroupOrgan	/restapi/v1.0/rms/devices/groups	GET	导入组织的列表。
listDeviceGroupInfo	/restapi/v1.0/rms/devices/groups/{groupId}	GET	导入 {groupId} 组的详细信息。
listDeviceGroupChild	/restapi/v1.0/rms/devices/groups/{groupId}/child	GET	导入 {groupId} 下子组的相关信息。

用户

添加用户并管理用户信息。具有读取、写入和管理用户权限的经验证用户可以访问用户相关服务。

可用的用户管理服务如下：

服务名称	API 调用	调用类别	说明
createUser	/restapi/v1.0/ums/users	POST	添加用户。
listDashboardUserInfo	/restapi/v1.0/ums/users/dashboard	GET	从仪表板导入必要的用户信息。
updateMyInfo	/restapi/v1.0/ums/users/me	PUT	编辑用户信息。
listUserOrgan	/restapi/v1.0/ums/users/organization	GET	导入组织的列表。此选项可用于配置组树。
listUserGroupOrgan	/restapi/v1.0/ums/users/groups	GET	导入组织的列表。
listUserGroupInfo	/restapi/v1.0/ums/users/groups/{groupId}	GET	导入 {groupId} 组的详细信息。
listUserGroupChild	/restapi/v1.0/ums/users/groups/{groupId}/child	GET	导入 {groupId} 组下子组的列表。

设置

除了主要功能以外，您还可以使用许多其他功能来创建和管理标签和类别，以及编辑仪表板。

服务名称	API 调用	调用类别	说明
getCategoryInfo	/restapi/v1.0/ems/category/{categoryId}	GET	导入类别列表。
deleteDashboard	/restapi/v1.0/ems/dashboard	DELETE	删除特定仪表板信息。
listDashboardInfo	/restapi/v1.0/ems/dashboard	GET	导入要在自定义仪表板上显示的内容。可以在仪表板上仅显示特定信息。
updateDashboardPriority	/restapi/v1.0/ems/dashboard	PUT	更改仪表板上所显示项目的顺序。
createDashboard	/restapi/v1.0/ems/dashboard/create	GET	激活空闲的仪表板。
listDashboardLoginInfo	/restapi/v1.0/ems/dashboard/login	GET	导入要在仪表板上显示的登录信息。
listDashboardNoticeInfo	/restapi/v1.0/ems/dashboard/notice	GET	导入要在仪表板上显示的公告板信息。
deleteNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	DELETE	从公告板删除帖子。
listEditNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	GET	导入所选帖子的详细信息。
createNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	POST	将帖子添加到公告板。
updateNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	PUT	编辑公告板上所选的贴子。
listDashboardStorageInfo	/restapi/v1.0/ems/dashboard/storage	GET	导入要在仪表板上显示的存储信息。
listLicense	/restapi/v1.0/ems/license	GET	导入服务器上注册的许可证列表。
getServerSetupInfo	/restapi/v1.0/ems/setup	GET	导入服务器设置。服务器设置项目包括可在服务器上打开或关闭不同功能的选项。
getTagListInfo	/restapi/v1.0/ems/tag	POST	导入服务器上注册的标签列表。

Open API 详细信息 (swagger UI)

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

Sv translation

language	tr

MagicINFO Server, Open API’ye (v2.0) çağrı yaparak içerik yönetimi, zamanlama yönetimi, aygıt yönetimi ve diğer işlevleri gerçekleştirmenize olanak sağlar.

Open API’yi (v2.0) kullanmak için önce bir kimlik denetimi sürecini tamamlamanız gerekir. API’leri test ederken her bir API için farklı bir swagger sayfası kullanın.

Kimlik denetimi

Open API (v2.0) öğelerine çağrı yapılırken api_token değerinin başlık bölümüne eklenmesi gerekir. Eklenmezse “401 Unauthorized” hatası döndürülür.

Belirlenen zaman diliminden sonra, alınan belirtecin tarihi geçer ve kullanılamaz hale gelir. Bu durumda yeni bir belirteç almanız gerekir.

api_token değeri aşağıdaki API’ye yapılacak bir çağrı aracılığıyla edinilebilir.

Hizmet Adı	API çağrısı	çağrı Türü	Açıklama
authenticationRequest	/auth	POST	Kullanıcı kimliği ve parolasını kullanarak kimlik denetimi için bir belirteç değeri içeri aktarır.
authenticationRequest	/auth/refresh	GET	Geçerlilik süresini uzatmak için yeni bir belirteç oluşturur. Tekrar oturum açmadan REST API’ye çağrı yapılabilir

OPEN API (v2.0)

MagicINFO Server Open API (v2.0) çeşitli işlevler sunar. Her bir işleve yönelik yapılandırma aşağıda gösterilmiştir.

Kategori	Denetleyici	Açıklama
İçerik	content-controller	İçerik dosyası yönetimi
İçerik	content-group-controller	İçerik grubu yönetimi
Oynatma listesi	playlist-controller	Bir çalma listesinin yönetilmesi
Oynatma listesi	playlist-group-controller	çalma listesi grubu yönetimi
Zamanlama	content-schedule-controller	İçerik zamanlaması yönetimi
	content-schedule-group-controller	İçerik zamanlaması grubu yönetimi
	message-schedule-controller	Mesaj zamanlaması yönetimi
	message-schedule-group-controller	Mesaj zamanlaması grubu yönetimi
Aygıt	device-controller	Aygıt yönetimi
Aygıt	device-group-controller	Aygıt grubu yönetimi
Kullanıcı	user-controller	Kullanıcı yönetimi
Kullanıcı	user-group-controller	Kullanıcı grubu yönetimi
Ayar	environment-controller	Ayar

İçerik

İçerik yükleyin, onaylayın ya da silin. İçerik listelerini yönetin. İçerikle ilgili hizmetlere içerik okuma, yazma ve yönetme izni olan doğrulanmış kullanıcıların erişimi vardır.

Kullanılabilen içerik yönetimi hizmetleri şunlardır:

Hizmet Adı	API çağrısı	çağrı Türü	Açıklama
listAllContent	/restapi/v1.0/cms/contents	GET	Karşıya yüklenmiş dosyaların listesini içeri aktarır. Listede içerik küçük resimleri, isimler, dosya türleri ve diğer temel bilgiler bulunur. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
listDashboardContentInfo	/restapi/v1.0/cms/contents/dashboard	GET	Kontrol panelinde gösterilecek genel içerik bilgilerini içeri aktarır.
listContent	/restapi/v1.0/cms/contents/filter	POST	Koşula göre filtrelenmiş bir içerik listesini içeri aktarır. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
forceDeleteContent	/restapi/v1.0/cms/contents/force/{contentId}	DELETE	İçeriğin bir çalma listesine ya da zamanlamaya dahil edilmiş olup olmaması fark etmeksizin içeriği siler.
deleteContent	/restapi/v1.0/cms/contents/{contentId}	DELETE	İçeriğin bir çalma listesine ya da zamanlamaya dahil edilmemiş olduğunu onayladıktan sonra içeriği siler. Bir çalma listesine veya zamanlamaya dahil edilmiş bir içerik silinmeye çalışılıyorsa içerik silinmez ve bir hata kodu döndürülür.
getActiveContentInfo	/restapi/v1.0/cms/contents/{contentId}	GET	İçeriğin aktifleştirilmiş bir sürümünün detaylarını içeri aktarır. İçerik her düzenlendiğinde sürümü güncellenir.
approveContents	/restapi/v1.0/cms/contents/{contentId}/approval	PUT	İçeriği onaylar veya reddeder. Onaylanan içerik genel içerik listesine aktarılır ve çalma listelerinde veya zamanlamalarda kullanılabilir.
uploadContent	/restapi/v1.0/cms/contents/{groupId}	POST	Yeni içeriği karşıya yükler.
listDefaultGroup	/restapi/v1.0/cms/contents/groups	GET	Varsayılan içerik gruplarının listesini içeri aktarır.
getGroup	/restapi/v1.0/cms/contents/groups/{groupId}	GET	{groupId} grubunun detaylarını içeri aktarır.
listChildGroup	/restapi/v1.0/cms/contents/groups/{groupId}/child	GET	{groupId} grubunun altındaki alt grupların listesini içeri aktarır.

Oynatma listesi

İçeriği kullanarak çalma listeleri oluşturun, düzenleyin veya silin. çalma listesiyle ilgili hizmetlere içerik okuma, yazma ve yönetme izni olan doğrulanmış kullanıcıların erişimi vardır.

Kullanılabilir çalma listesi yönetimi hizmetleri şunlardır:

Hizmet Adı	API çağrısı	çağrı Türü	Açıklama
listAllPlaylist	/restapi/v1.0/cms/playlists	GET	Tüm çalma listelerinin listesini içeri aktarır. Listede çalma listesi isimleri, ana içeriğin küçük resimleri, çalma listesi türleri ve diğer temel bilgiler bulunur. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
createPlaylist	/restapi/v1.0/cms/playlists	POST	Yeni bir çalma listesi oluşturur.
getDashboardPlaylistInfo	/restapi/v1.0/cms/playlists/dashboard	GET	Kontrol panelinden gerekli çalma listesi bilgilerini içeri aktarır.
listPlaylist	/restapi/v1.0/cms/playlists/filter	POST	Koşula göre filtrelenmiş çalma listelerinin bir listesini içeri aktarır. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
deletePlaylist	/restapi/v1.0/cms/playlists/{playlistId}	DELETE	Seçilen çalma listesini siler. Bir zamanlamaya dahil edilmiş bir çalma listesi silinmeye çalışılıyorsa çalma listesi silinmez ve bir hata kodu döndürülür.
getActivePlaylistInfo	/restapi/v1.0/cms/playlists/{playlistId}	GET	çalma listesinin aktifleştirilmiş bir sürümünün detaylarını içeri aktarır. çalma listesi her düzenlendiğinde sürümü güncellenir.
editPlaylist	/restapi/v1.0/cms/playlists/{playlistId}	PUT	{playlistId} çalma listesini düzenler. Bir çalma listesi düzenlenlendiğinde çalma listesi sürümü güncellenir ve çalma listesini oynatan aygıt, güncellenmiş çalma listesini otomatik olarak oynatır.
copyPlaylist	/restapi/v1.0/cms/playlists/{playlistId}/copy	PUT	{playlistId} çalma listesini kopyalar. çalma listesinin bir kopyası oluşturulur.
listDefaultGroup	/restapi/v1.0/cms/playlists/groups	GET	Varsayılan çalma listesi gruplarının bir listesini içeri aktarır.
getGroup	/restapi/v1.0/cms/playlists/groups/{groupId}	GET	{groupId} grubunun detaylarını içeri aktarır.
listChildGroup	/restapi/v1.0/cms/playlists/groups/{groupId}/child	GET	{groupId} grubunun altındaki alt grupların listesini içeri aktarır.

Zamanlama

Yeni içerik ya da mesaj zamanlamaları oluşturun. Zamanlamaları oynatma için aygıtlara yayınlayın. Zamanlamaları düzenleyin veya silin.

Zamanlama ile ilgili hizmetlere zamanlamaları okuma, yazma ve yönetme izni olan doğrulanmış kullanıcıların erişimi vardır.

Kullanılabilir zamanlama yönetimi hizmetleri şunlardır:

Hizmet Adı	API çağrısı	çağrı Türü	Açıklama
listContentScheduleAll	/restapi/v1.0/dms/schedule/contents	GET	İçerik zamanlamalarının listesini içeri aktarır. Listede içerik zamanlamalarının isimleri, oluşturulma tarihleri, aygıt türleri ve diğer temel bilgiler bulunur. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
createContentSchedule	/restapi/v1.0/dms/schedule/contents	POST	Yeni bir içerik zamanlaması oluşturur. İçerik zamanlamaları birden fazla kanal ve çerçeve içerebilir. Aygıtlara bir zamanlama yayınlayıp arzu edilen içerik ya da çalma listesini belirlenen zamanda oynatın.
listDashboardScheduleInfo	/restapi/v1.0/dms/schedule/contents/dashboard	GET	Kontrol panelinden gerekli içerik zamanlama bilgilerini içeri aktarır.
listContentScheduleByGroup	/restapi/v1.0/dms/schedule/contents/filter	POST	Farklı koşullara göre filtrelenmiş bir içerik zamanlaması listesini içeri aktarır. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
deleteContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	DELETE	İçerik zamanlamasını siler. Daha önce bir aygıta yayınlanmış bir zamanlama siliniyorsa aygıt otomatik olarak varsayılan içeriği oynatır.
getProgramInfo	/restapi/v1.0/dms/schedule/contents/{programId}	GET	Seçilen grubun detaylarını içeri aktarır.
editContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	PUT	İçerik zamanlamasını düzenler. Daha önce bir aygıta yayınlanmış bir zamanlama düzenleniyorsa aygıt otomatik olarak düzenlenmiş içeriği oynatır.
copyContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/copy	PUT	{programId} içerik zamanlamasını kopyalar. {programId} içerik zamanlamasının bir kopyası oluşturulur.
deployContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/deploy	PUT	İçerik zamanlamasını belirli bir aygıt grubuna yayınlar.
getPublishStatus	/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus	GET	Gerçek zamanlı içerik zamanlaması indirme durumunu bir aygıttan içeri aktarır.
getRootGroups	/restapi/v1.0/dms/schedule/contents/groups	GET	İçerik zamanlaması için kök grupların listesini içeri aktarır.
listContentScheduleGroupInfo	/restapi/v1.0/dms/schedule/contents/groups/{groupId}	GET	{groupId} grubunun detaylarını içeri aktarır.
listAllMessageSchedule	/restapi/v1.0/dms/schedule/messages	GET	Tüm mesaj zamanlamalarının listesini içeri aktarır.
createMessageSchedule	/restapi/v1.0/dms/schedule/messages	POST	Yeni bir mesaj programı oluşturur.
listMessage	/restapi/v1.0/dms/schedule/messages/filter	POST	Farklı koşullara göre filtrelenmiş bir mesaj zamanlaması listesini içeri aktarır. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
deleteMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	DELETE	Seçilen mesaj zamanlamasını siler. Daha önce bir aygıta yayınlanmış bir mesaj zamanlaması siliniyorsa değişiklik otomatik olarak aygıta uygulanır.
getMessageInfo	/restapi/v1.0/dms/schedule/messages/{messageId}	GET	Seçilen mesaj zamanlamasının detaylarını içeri aktarır.
editMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	PUT	Seçilen mesaj zamanlamasını düzenler. Daha önce bir aygıta yayınlanmış bir mesaj zamanlaması düzenleniyorsa değişiklik otomatik olarak aygıta uygulanır.
copyMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/copy	PUT	Seçilen mesaj zamanlamasını kopyalar. Mesaj zamanlamasının bir kopyası oluşturulur.
deployMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/deploy	PUT	Seçilen mesaj zamanlamasını bir aygıt grubuna yayınlar.
getRootGroups	/restapi/v1.0/dms/schedule/messages/groups	GET	İçerik zamanlaması için kök grupların listesini içeri aktarır.
listMessageScheduleGroupInfo	/restapi/v1.0/dms/schedule/messages/groups/{groupId}	GET	{groupId} grubunun detaylarını içeri aktarır.
getChildGroups	/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child	GET	Belirli bir grubun altındaki alt grupların listesini içeri aktarır.

Aygıt

Aygıtları kontrol edin ve yönetin. Aygıtlarla ilgili hizmetlere aygıtları okuma, yazma ve yönetme izni olan doğrulanmış kullanıcıların erişimi vardır.

Mevcut aygıt yönetimi hizmetleri şunlardır:

Hizmet Adı	API çağrısı	çağrı Türü	Açıklama
listAllDevice	/restapi/v1.0/rms/devices	GET	Tüm aygıtların listesini içeri aktarır. Listede aygıt güç durumları, küçük resim bilgisi, aygıt hata durumları ve diğer temel bilgiler bulunur. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
getDashboardDeviceInfo	/restapi/v1.0/rms/devices/dashboard	GET	Kontrol panelinden gerekli aygıt bilgilerini içeri aktarır.
filterDeviceList	/restapi/v1.0/rms/devices/filter	POST	Farklı koşullara göre filtrelenmiş bir aygıt listesini içeri aktarır. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
deleteDevice	/restapi/v1.0/rms/devices/{deviceId}	DELETE	Seçilen aygıtı siler.
getDevice	/restapi/v1.0/rms/devices/{deviceId}	GET	Seçilen aygıtın detaylarını içeri aktarır.
approveDevice	/restapi/v1.0/rms/devices/{deviceId}/approval	PUT	Seçilen aygıtı belirli bir grup için onaylar.
getCabinetList	/restapi/v1.0/rms/devices/{deviceId}/cabinet	POST	LED aygıtına bağlanmış cabinet'ler hakkındaki bilgileri içeri aktarır. İçeri aktarılan bilgiler sadece cabinet'ler bir LED aygıtına bağlı olduğu zaman geçerlidir.
updateCabinetInfo	/restapi/v1.0/rms/devices/{deviceId}/cabinet	PUT	LED aygıtına bağlanmış cabinet'ler hakkındaki bilgileri düzenler.
getDisplayControlInfo	/restapi/v1.0/rms/devices/{deviceId}/display	GET	Veri tabanından aygıt ekran kontrol bilgilerini içeri aktarır. Kontrol bilgisi yoksa aygıta bir bilgi isteği gönderilmelidir.
updateDisplayInfo	/restapi/v1.0/rms/devices/{deviceId}/display	PUT	Düzenlenmiş ekran kontrol bilgilerini bir aygıta gönderir. Aygıta sadece ekran bilgisindeki düzenlenmiş değerler protokol olarak gönderilir.
getUpdatedDisplayInfoResult	/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}	GET	Aygıttan düzenlenmiş ekran kontrol bilgilerini alır. Bu API, updateDisplayInfo API’si yürütüldükten sonra yürütülebilir.
getGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general	GET	Veri tabanından genel aygıt bilgilerini içeri aktarır. Genel aygıt bilgisi, aygıt sunucuya bağlandığında güncellenir.
updateGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general/info	PUT	Düzenlenmiş aygıt bilgilerini bir aygıta gönderir. Aygıta sadece temel aygıt bilgisindeki düzenlenmiş değerler protokol olarak gönderilir.
getUpdatedGeneralInfoResult	/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}	GET	Aygıttan düzenlenmiş aygıt bilgilerini alır. Bu API, updateGeneralInfo API’si yürütüldükten sonra yürütülebilir.
moveDevice	/restapi/v1.0/rms/devices/{deviceId}/move	PUT	Aygıtı farklı bir gruba taşır.
startRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/start	GET	Aygıta bir RM başlatma protokolü gönderir. RM başlatma protokolü alan bir aygıt, Uzaktan Kumanda Sunucusu aracılığıyla düzenli aralıklarla bilgi gönderir.
stopRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop	GET	RM durdurma protokolünü bir aygıta gönderir. RM durdurma protokolü alan bir aygıt ilgili işlevi anında durdurur.
getSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	GET	Aygıt ayarlarını içeri aktarır. Aygıt ayarları, aygıt sunucuya bağlandığında güncellenir.
updateSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	PUT	Düzenlenmiş aygıt ayarlarını bir aygıta gönderir. Aygıta sadece ayarlardaki düzenlenmiş değerler protokol olarak gönderilir.
getUpdatedSetupInfoResult	/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}	GET	Aygıttan düzenlenmiş aygıt ayarlarını alır. Bu API, updateSetupInfo API’si yürütüldükten sonra yürütülebilir.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display	GET	Aygıta mevcut ekran kontrol bilgileri için bir istek gönderir. Bu API çağırılırsa requestId cevap değeri olarak döndürülür.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}	GET	Aygıttan gönderilen ekran kontrol bilgisini içeri aktarır. Bu seçenek iki eylem için kullanılır: aygıta bilgi isteği göndermek ve asıl aygıt bilgisini almak.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time	GET	Aygıta mevcut zaman bilgisi için bir istek gönderir. Bu API çağırılırsa requestId cevap değeri olarak döndürülür.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}	GET	Aygıttan gönderilen zaman bilgisini içeri aktarır. Bu seçenek iki eylem için kullanılır: aygıta bilgi isteği göndermek ve asıl aygıt bilgisini almak.
getTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	GET	Veritabanından aygıt zaman bilgilerini içeri aktarır. Kontrol bilgisi yoksa aygıta bir bilgi isteği gönderilmelidir.
updateTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	PUT	Aygıta düzenlenmiş zaman bilgilerini gönderir. Aygıta sadece zaman bilgisindeki düzenlenmiş değerler protokol olarak gönderilir.
getUpdatedTimeInfoResult	/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}	GET	Aygıttan düzenlenmiş aygıt zaman bilgilerini alır. Bu API, getUpdatedTimeInfoResult API’si yürütüldükten sonra yürütülebilir.
listDeviceGroupOrgan	/restapi/v1.0/rms/devices/groups	GET	Organizasyonların listesini içeri aktarır.
listDeviceGroupInfo	/restapi/v1.0/rms/devices/groups/{groupId}	GET	{groupId} grubunun detaylarını içeri aktarır.
listDeviceGroupChild	/restapi/v1.0/rms/devices/groups/{groupId}/child	GET	{groupId} grubunun altındaki alt gruplar hakkındaki bilgileri içeri aktarır.

Kullanıcı

Kullanıcı ekleyip kullanıcı bilgilerini yönetin. Kullanıcılarla ilgili hizmetlere kullanıcı bilgilerini okuma, yazma ve yönetme izni olan doğrulanmış kullanıcıların erişimi vardır.

Mevcut kullanıcı yönetimi hizmetleri şunlardır:

Hizmet Adı	API çağrısı	çağrı Türü	Açıklama
createUser	/restapi/v1.0/ums/users	POST	Kullanıcı ekler.
listDashboardUserInfo	/restapi/v1.0/ums/users/dashboard	GET	Kontrol panelinden gerekli kullanıcı bilgilerini içeri aktarır.
updateMyInfo	/restapi/v1.0/ums/users/me	PUT	Kullanıcı bilgisini düzenler.
listUserOrgan	/restapi/v1.0/ums/users/organization	GET	Organizasyonların listesini içeri aktarır. Bu seçenek bir grup ağacını yapılandırmak için kullanılabilir.
listUserGroupOrgan	/restapi/v1.0/ums/users/groups	GET	Organizasyonların listesini içeri aktarır.
listUserGroupInfo	/restapi/v1.0/ums/users/groups/{groupId}	GET	{groupId} grubunun detaylarını içeri aktarır.
listUserGroupChild	/restapi/v1.0/ums/users/groups/{groupId}/child	GET	{groupId} grubunun altındaki alt grupların listesini içeri aktarır.

Ayar

Ana işlevlere ek olarak, birçok diğer işlevi kullanarak da etiket ve kategorileri oluşturup yönetebilir ve kontrol panelini düzenleyebilirsiniz.

Hizmet Adı	API çağrısı	çağrı Türü	Açıklama
getCategoryInfo	/restapi/v1.0/ems/category/{categoryId}	GET	Kategorilerin listesini içeri aktarır.
deleteDashboard	/restapi/v1.0/ems/dashboard	DELETE	Belirli bir kontrol paneli bilgisini siler.
listDashboardInfo	/restapi/v1.0/ems/dashboard	GET	özelleştirilmiş kontrol panelinde gösterilecek içeriği içeri aktarır. Kontrol panelinde sadece belirli bilgiler gösterilebilir.
updateDashboardPriority	/restapi/v1.0/ems/dashboard	PUT	Kontrol panelinde gösterilen öğelerin sıralamasını değiştirir.
createDashboard	/restapi/v1.0/ems/dashboard/create	GET	Boştaki bir kontrol panelini aktifleştirir.
listDashboardLoginInfo	/restapi/v1.0/ems/dashboard/login	GET	Kontrol panelinde gösterilecek giriş bilgilerini içeri aktarır.
listDashboardNoticeInfo	/restapi/v1.0/ems/dashboard/notice	GET	Kontrol panelinde gösterilecek ilan panosu bilgilerini içeri aktarır.
deleteNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	DELETE	İlan panosundan bir gönderiyi siler.
listEditNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	GET	Seçilen gönderinin detaylarını içeri aktarır.
createNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	POST	İlan panosuna gönderiler ekler.
updateNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	PUT	İlan panosunda seçili gönderiyi düzenler.
listDashboardStorageInfo	/restapi/v1.0/ems/dashboard/storage	GET	Kontrol panelinde gösterilecek depolama bilgilerini içeri aktarır.
listLicense	/restapi/v1.0/ems/license	GET	Sunucudaki kayıtlı lisansların listesini içeri aktarır.
getServerSetupInfo	/restapi/v1.0/ems/setup	GET	Sunucu ayarlarını içeri aktarır. Sunucu ayarı öğeleri, sunucudaki farklı işlevleri kapatıp açabilecek seçenekler içerir.
getTagListInfo	/restapi/v1.0/ems/tag	POST	Sunucuda kayıtlı etiketlerin listesini içeri aktarır.

Open API Detayları (swagger UI)

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

Sv translation

language	sv

I MagicINFO Server kan du implementera innehållshantering, schemahantering, enhetshantering och andra funktioner genom att anropa Open API (v2.0).

Om du vill använda Open API (v2.0) måste du först gå igenom en autentiseringsprocess. Använd en särskild swagger-sida för att testa varje API.

Autentisering

När du anropar alla Open API (v2.0)-objekt, måste api_token ingå i huvudet. Om detta inte tas med returneras felet "401 Unauthorized".

En erhållen token upphör att gälla och blir omöjlig att använda efter en viss tid. Om så är fallet bör du skaffa en ny token.

api_token kan erhållas genom att man anropar följande api.

Servicenamn	API-anrop	Anropstyp	Beskrivning
authenticationRequest	/auth	POST	Importerar ett token-värde för autentisering med hjälp av användar-ID:t och lösenordet.
authenticationRequest	/auth/refresh	GET	Skapar en ny token för att förlänga giltighetstiden. Det är möjligt att anropa REST API utan att logga in igen.

OPEN API (v2.0)

MagicINFO Server Open API (v2.0) innehåller en mängd olika funktioner. Konfiguration av varje funktion visas nedan.

Kategori	Styrenhet	Beskrivning
Innehåll	content-controller	Hantering av innehåll
Innehåll	content-group-controller	Hantering av innehållsgrupper
Spellista	playlist-controller	Hantera spellistor
Spellista	playlist-group-controller	Hantering av spellistegrupper
Schema	content-schedule-controller	Hantering av innehållsscheman
	content-schedule-group-controller	Hantering av grupper av innehållsscheman
	message-schedule-controller	Hantering av meddelandescheman
	message-schedule-group-controller	Hantering av grupper av meddelandescheman
Enhet	device-controller	Enhetshantering
Enhet	device-group-controller	Hantering av enhetsgrupper
Användare	user-controller	Användarhantering
Användare	user-group-controller	Hantering av användargrupper
Inställning	environment-controller	Inställning

Innehåll

överföra, godkänna och radera innehåll. Hantera innehållslistor. Innehållsrelaterade tjänster är tillgängliga för autentiserade användare med behörighet att läsa, skriva och hantera innehåll.

Följande innehållshanteringstjänster är tillgängliga:

Servicenamn	API-anrop	Anropstyp	Beskrivning
listAllContent	/restapi/v1.0/cms/contents	GET	Importerar en lista med överfört innehåll. Innehållsminiatyrer, namn, filtyper och andra grundläggande uppgifter ingår i listan. Listor kan importeras per sida med hjälp av sidindelningsinformation.
listDashboardContentInfo	/restapi/v1.0/cms/contents/dashboard	GET	Importerar allmän innehållsinformation som ska visas på instrumentpanelen.
listContent	/restapi/v1.0/cms/contents/filter	POST	Importerar en lista med innehåll som filtrerats baserat på villkor. Listor kan importeras per sida med hjälp av sidindelningsinformation.
forceDeleteContent	/restapi/v1.0/cms/contents/force/{contentId}	DELETE	Tar bort innehållet, oavsett om innehållet ingår i en spellista eller ett schema.
deleteContent	/restapi/v1.0/cms/contents/{contentId}	DELETE	Tar bort innehåll efter en kontroll av att innehållet inte ingår i en spellista eller ett schema. Om du försöker ta bort innehåll som ingår i en spellista eller ett schema, tas innehållet inte bort och en felkod returneras.
getActiveContentInfo	/restapi/v1.0/cms/contents/{contentId}	GET	Importerar information om en aktiverad version av ett visst innehåll. Innehållets version uppdateras varje gång innehållet redigeras.
approveContents	/restapi/v1.0/cms/contents/{contentId}/approval	PUT	Godkänner/avvisar innehåll. Godkänt innehåll flyttas till den allmänna innehållslistan och kan användas i spellistor och scheman.
uploadContent	/restapi/v1.0/cms/contents/{groupId}	POST	överför nytt innehåll.
listDefaultGroup	/restapi/v1.0/cms/contents/groups	GET	Importerar en lista med standardinnehållsgrupper.
getGroup	/restapi/v1.0/cms/contents/groups/{groupId}	GET	Importerar information om gruppen {groupId}.
listChildGroup	/restapi/v1.0/cms/contents/groups/{groupId}/child	GET	Importerar en lista med undergrupper under gruppen {groupId}.

Spellista

Använd innehåll för att skapa, redigera och ta bort spellistor. Spellisterelaterade tjänster är tillgängliga för autentiserade användare med behörighet att läsa, skriva och hantera innehåll.

Följande spellistehanteringstjänster är tillgängliga:

Servicenamn	API-anrop	Anropstyp	Beskrivning
listAllPlaylist	/restapi/v1.0/cms/playlists	GET	Importerar en lista med samtliga spellistor. Spellistenamn, huvudinnehållsminiatyrer, spellistetyper och annan grundläggande information ingår i listan. Listor kan importeras per sida med hjälp av sidindelningsinformation.
createPlaylist	/restapi/v1.0/cms/playlists	POST	Skapa en ny spellista.
getDashboardPlaylistInfo	/restapi/v1.0/cms/playlists/dashboard	GET	Importerar nödvändig spellisteinformation från instrumentpanelen.
listPlaylist	/restapi/v1.0/cms/playlists/filter	POST	Importerar en lista med spellistor som filtrerats baserat på villkor. Listor kan importeras per sida med hjälp av sidindelningsinformation.
deletePlaylist	/restapi/v1.0/cms/playlists/{playlistId}	DELETE	Ta bort den markerade spellistan. Om du försöker ta bort en spellista som ingår i en ett schema, tas spellistan inte bort och en felkod returneras.
getActivePlaylistInfo	/restapi/v1.0/cms/playlists/{playlistId}	GET	Importerar information om en aktiverad version av en spellista. Spellistans version uppdateras varje gång spellistan redigeras.
editPlaylist	/restapi/v1.0/cms/playlists/{playlistId}	PUT	Redigerar spellistan {playlistId}. När en spellista redigeras uppdateras dess version, och den spelare som spelar upp spellistan spelar automatiskt upp den uppdaterade spellistan.
copyPlaylist	/restapi/v1.0/cms/playlists/{playlistId}/copy	PUT	Kopierar spellistan {playlistId}. En kopia av spellistan skapas.
listDefaultGroup	/restapi/v1.0/cms/playlists/groups	GET	Importerar en lista med grupper av standardspellistor.
getGroup	/restapi/v1.0/cms/playlists/groups/{groupId}	GET	Importerar information om gruppen {groupId}.
listChildGroup	/restapi/v1.0/cms/playlists/groups/{groupId}/child	GET	Importerar en lista med undergrupper under gruppen {groupId}.

Schema

Skapa nya innehålls- eller meddelandescheman. Publicera scheman till enheter för uppspelning. Redigera eller ta bort scheman.

Schemarelaterade tjänster är tillgängliga för autentiserade användare med behörighet att läsa, skriva och hantera scheman.

Följande schemahanteringstjänster är tillgängliga:

Servicenamn	API-anrop	Anropstyp	Beskrivning
listContentScheduleAll	/restapi/v1.0/dms/schedule/contents	GET	Importerar en lista med alla innehållsscheman. Innehållsschemanamn, tillkomstdatum, spellistetyper och annan grundläggande information ingår i listan. Listor kan importeras per sida med hjälp av sidindelningsinformation.
createContentSchedule	/restapi/v1.0/dms/schedule/contents	POST	Skapar ett nytt innehållsschema. Ett innehållsschema kan innehålla flera kanaler och ramar. Publicera ett schema till enheter och spela upp önskat innehåll eller en önskad spellista vid en angiven tidpunkt.
listDashboardScheduleInfo	/restapi/v1.0/dms/schedule/contents/dashboard	GET	Import nödvändig innehållsschemainformation från instrumentpanelen.
listContentScheduleByGroup	/restapi/v1.0/dms/schedule/contents/filter	POST	Importerar en lista med innehållsscheman som filtrerats baserat på olika villkor. Listor kan importeras per sida med hjälp av sidindelningsinformation.
deleteContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	DELETE	Ta bort ett innehållsschema. Om du tar bort ett schema som tidigare har publicerats till en enhet, spelar enheten automatiskt upp standardinnehållet.
getProgramInfo	/restapi/v1.0/dms/schedule/contents/{programId}	GET	Importerar information om det markerade schemat.
editContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	PUT	Redigerar ett innehållsschema. Om du redigerar ett schema som tidigare har publicerats till en enhet, spelar enheten automatiskt upp det redigerade schemat.
copyContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/copy	PUT	Kopierar innehållsschemat {programId}. En kopia av innehållsschemat {programId} skapas.
deployContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/deploy	PUT	Publicerar ett innehållsschema till en specifik enhetsgrupp.
getPublishStatus	/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus	GET	Importerar hämtningsstatus för innehållsscheman i realtid från en enhet.
getRootGroups	/restapi/v1.0/dms/schedule/contents/groups	GET	Importerar en lista med rotgrupper för ett innehållsschema.
listContentScheduleGroupInfo	/restapi/v1.0/dms/schedule/contents/groups/{groupId}	GET	Importerar information om gruppen {groupId}.
listAllMessageSchedule	/restapi/v1.0/dms/schedule/messages	GET	Importerar en lista med samtliga meddelandescheman.
createMessageSchedule	/restapi/v1.0/dms/schedule/messages	POST	Skapar ett nytt meddelandeschema.
listMessage	/restapi/v1.0/dms/schedule/messages/filter	POST	Importerar en lista med meddelandescheman som filtrerats baserat på olika villkor. Listor kan importeras per sida med hjälp av sidindelningsinformation.
deleteMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	DELETE	Tar bort det markerade meddelandeschemat. Om du tar bort ett meddelandeschema som tidigare har publicerats till en enhet, tillämpas ändringen automatiskt på enheten.
getMessageInfo	/restapi/v1.0/dms/schedule/messages/{messageId}	GET	Importerar information om det markerade meddelandeschemat.
editMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	PUT	Redigerar det markerade meddelandeschemat. Om du redigerar ett meddelandeschema som tidigare har publicerats till en enhet, tillämpas ändringen automatiskt på enheten.
copyMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/copy	PUT	Kopierar det markerade meddelandeschemat. En kopia av meddelandeschemat skapas.
deployMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/deploy	PUT	Publicerar det markerade meddelandeschemat till en enhetsgrupp.
getRootGroups	/restapi/v1.0/dms/schedule/messages/groups	GET	Importerar en lista med rotgrupper för ett innehållsschema.
listMessageScheduleGroupInfo	/restapi/v1.0/dms/schedule/messages/groups/{groupId}	GET	Importerar information om gruppen {groupId}.
getChildGroups	/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child	GET	Importerar en lista med undergrupper under en specifik grupp.

Enhet

Styr och hantera enheter. Enhetsrelaterade tjänster är tillgängliga för autentiserade användare med behörighet att läsa, skriva och hantera enheter.

Följande enhetshanteringstjänster är tillgängliga:

Servicenamn	API-anrop	Anropstyp	Beskrivning
listAllDevice	/restapi/v1.0/rms/devices	GET	Importerar en lista med samtliga enheter. Enheters strömstatus, information om miniatyrer, enheters felstatus och annan grundläggande information ingår i listan. Listor kan importeras per sida med hjälp av sidindelningsinformation.
getDashboardDeviceInfo	/restapi/v1.0/rms/devices/dashboard	GET	Importerar nödvändig enhetsinformation från instrumentpanelen.
filterDeviceList	/restapi/v1.0/rms/devices/filter	POST	Importerar en lista med enheter som filtrerats baserat på olika villkor. Listor kan importeras per sida med hjälp av sidindelningsinformation.
deleteDevice	/restapi/v1.0/rms/devices/{deviceId}	DELETE	Tar bort den markerade enheten.
getDevice	/restapi/v1.0/rms/devices/{deviceId}	GET	Importerar information om markerade enheter.
approveDevice	/restapi/v1.0/rms/devices/{deviceId}/approval	PUT	Godkänner den markerade enheten för en specifik grupp.
getCabinetList	/restapi/v1.0/rms/devices/{deviceId}/cabinet	POST	Importerar information om Cabinet som är anslutna till en LED-enhet. Den importerade informationen är endast giltig när dina Cabinet är anslutna till en LED-enhet.
updateCabinetInfo	/restapi/v1.0/rms/devices/{deviceId}/cabinet	PUT	Redigerar information om Cabinet som är anslutna till en LED-enhet.
getDisplayControlInfo	/restapi/v1.0/rms/devices/{deviceId}/display	GET	Importerar enhetens skärmstyrningsinformation från databasen. Om det inte finns någon styrningsinformation ska en informationsbegäran skickas till enheten.
updateDisplayInfo	/restapi/v1.0/rms/devices/{deviceId}/display	PUT	Skickar redigerad skärmstyrningsinformation till en enhet. Bara redigerade värden i skärminformationen skickas som ett protokoll till enheten.
getUpdatedDisplayInfoResult	/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}	GET	Tar emot redigerad skärmstyrningsinformation från en enhet. Detta API kan köras efter att API:t updateDisplayInfo har körts.
getGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general	GET	Importerar allmän enhetsinformation från databasen. Allmän enhetsinformation uppdateras när enheten ansluts till servern.
updateGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general/info	PUT	Skickar redigerad enhetsinformation till en enhet. Bara redigerade värden i den grundläggande enhetsinformationen skickas som ett protokoll till enheten.
getUpdatedGeneralInfoResult	/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}	GET	Tar emot redigerad enhetsinformation från en enhet. Detta API kan köras efter att API:t updateGeneralInfo har körts.
moveDevice	/restapi/v1.0/rms/devices/{deviceId}/move	PUT	Flyttar en enhet till en annan grupp.
startRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/start	GET	Skickar ett RM-startprotokoll till en enhet. En enhet som fått ett RM-startprotokoll skickar med jämna mellanrum information via fjärrservern.
stopRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop	GET	Skickar ett RM-stopprotokoll till en enhet. En enhet som fått ett stopprotokoll stoppar motsvarande funktion omedelbart.
getSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	GET	Importerar enhetsinställningar. Enhetens inställningar uppdateras när enheten ansluts till servern.
updateSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	PUT	Skickar redigerade enhetsinställningar till en enhet. Bara redigerade värden i inställningarna skickas som ett protokoll till enheten.
getUpdatedSetupInfoResult	/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}	GET	Tar emot redigerade enhetsinställningar från en enhet. Detta API kan köras efter att API:t updateSetupInfo har körts.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display	GET	Skickar en aktuell begäran om skärmstyrningsinformation till en enhet. Om detta API anropas, returneras requestId som svarsvärde.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}	GET	Importerar skärmstyrningsinformation som skickats från en enhet. Det här alternativet används för två åtgärder: för att skicka en begäran om information till en enhet och för att ta emot själva enhetsinformationen.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time	GET	Skickar en begäran om aktuell tidsinformation till en enhet. Om detta API anropas, returneras requestId som svarsvärde.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}	GET	Importerar tidsinformation som skickats från en enhet. Det här alternativet används för två åtgärder: för att skicka en begäran om information till en enhet och för att ta emot själva enhetsinformationen.
getTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	GET	Importerar tidsinformation för en enhet från databasen. Om det inte finns någon styrningsinformation ska en informationsbegäran skickas till enheten.
updateTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	PUT	Skickar redigerad tidsinformation till en enhet. Bara redigerade värden i tidsinformationen skickas som ett protokoll till enheten.
getUpdatedTimeInfoResult	/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}	GET	Tar emot redigerad enhetstidsinformation från en enhet. Detta API kan köras efter att API:t getUpdatedTimeInfoResult har körts.
listDeviceGroupOrgan	/restapi/v1.0/rms/devices/groups	GET	Importerar en lista med organisationer.
listDeviceGroupInfo	/restapi/v1.0/rms/devices/groups/{groupId}	GET	Importerar information om gruppen {groupId}.
listDeviceGroupChild	/restapi/v1.0/rms/devices/groups/{groupId}/child	GET	Importerar information om undergrupper under {groupId}.

Användare

Lägg till användare och hantera användarinformation. Användarrelaterade tjänster är tillgängliga för autentiserade användare med behörighet att läsa, skriva och hantera användarinformation.

Följande användarhanteringstjänster är tillgängliga:

Servicenamn	API-anrop	Anropstyp	Beskrivning
createUser	/restapi/v1.0/ums/users	POST	Lägger till en användare.
listDashboardUserInfo	/restapi/v1.0/ums/users/dashboard	GET	Importerar nödvändig användarinformation från instrumentpanelen.
updateMyInfo	/restapi/v1.0/ums/users/me	PUT	Redigerar användarinformation.
listUserOrgan	/restapi/v1.0/ums/users/organization	GET	Importerar en lista med organisationer. Det här alternativet kan användas för att konfigurera ett gruppträd.
listUserGroupOrgan	/restapi/v1.0/ums/users/groups	GET	Importerar en lista med organisationer.
listUserGroupInfo	/restapi/v1.0/ums/users/groups/{groupId}	GET	Importerar information om gruppen {groupId}.
listUserGroupChild	/restapi/v1.0/ums/users/groups/{groupId}/child	GET	Importerar en lista med undergrupper under gruppen {groupId}.

Inställning

Förutom huvudfunktionerna kan du använda många andra funktioner till att skapa och hantera taggar och kategorier samt redigera instrumentpanelen.

Servicenamn	API-anrop	Anropstyp	Beskrivning
getCategoryInfo	/restapi/v1.0/ems/category/{categoryId}	GET	Importerar en lista med kategorier.
deleteDashboard	/restapi/v1.0/ems/dashboard	DELETE	Tar bort specifik instrumentpanelsinformation.
listDashboardInfo	/restapi/v1.0/ems/dashboard	GET	Importerar innehåll som ska visas på den anpassade instrumentpanelen. Det går att visa endast specifik information på instrumentpanelen.
updateDashboardPriority	/restapi/v1.0/ems/dashboard	PUT	ändrar ordning på de objekt som visas på instrumentpanelen.
createDashboard	/restapi/v1.0/ems/dashboard/create	GET	Aktiverar en inaktiv instrumentpanel.
listDashboardLoginInfo	/restapi/v1.0/ems/dashboard/login	GET	Importerar inloggningsinformation som ska visas på instrumentpanelen.
listDashboardNoticeInfo	/restapi/v1.0/ems/dashboard/notice	GET	Importerar anslagstavleinformation som ska visas på instrumentpanelen.
deleteNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	DELETE	Tar bort ett inlägg från anslagstavlan.
listEditNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	GET	Importerar information om det markerade inlägget.
createNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	POST	Lägger till inlägg på anslagstavlan.
updateNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	PUT	Redigerar det markerade inlägget på anslagstavlan.
listDashboardStorageInfo	/restapi/v1.0/ems/dashboard/storage	GET	Importerar lagringsinformation som ska visas på instrumentpanelen.
listLicense	/restapi/v1.0/ems/license	GET	Importerar en lista med licenser som registrerats på servern.
getServerSetupInfo	/restapi/v1.0/ems/setup	GET	Importerar serverinställningar. Serverinställningsobjekt inkluderar alternativ som kan slå på och av olika funktioner på servern.
getTagListInfo	/restapi/v1.0/ems/tag	POST	Importerar en lista med taggar som registrerats på servern.

Open API-information (swagger UI)

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

Content

Space Tools

Page History

Versions Compared

Old Version 77

New Version Current

Key

التصديق

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

المحتوى.

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

جدول

الجهاز

المستخدم

الضبط

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

Authentification

OPEN API (v2.0)

Contenu :

Liste de lecture

Programme

Périphérique

Utilisateur

Réglage

Détails sur Open API (interface utilisateur Swagger)

Autenticação

OPEN API (v2.0)

Conteúdo

Lista de reprodução

Programar

Dispositivo

Utilizador

Definição

Detalhes da Open API (IU swagger)

Проверка подлинности

OPEN API (v2.0)

Содержимое

Плейлист

Расписание

Устройство

Пользователь

Настройка

Открытие подробных сведений API (swagger UI)

身份验证

OPEN API（2.0 版）

内容

播放列表

日程表

设备

用户

设置

Open API 详细信息 (swagger UI)

Kimlik denetimi

OPEN API (v2.0)

İçerik

Oynatma listesi

Zamanlama

Aygıt

Kullanıcı

Ayar

Open API Detayları (swagger UI)

Autentisering

OPEN API (v2.0)

Innehåll

Spellista

Schema

Enhet

Användare

Inställning

Open API-information (swagger UI)