Versions Compared

Key

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

...

Sv translation
languagear


يتيح لك خادم 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
languagept


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 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 chamadaDescrição
authenticationRequest

/auth

POSTPermite importar o valor de um token para efeitos de autenticação através da ID e da palavra-passe de utilizador.
authenticationRequest

/auth/refresh

GETPermite 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.  

CategoriaControladorDescrição
Conteúdocontent-controllerGestão de ficheiros de conteúdo
content-group-controllerGestão de grupos de conteúdo
Lista de reproduçãoplaylist-controllerGestão de listas de reprodução
playlist-group-controllerGestão de grupos de listas de reprodução
Programarcontent-schedule-controllerGestão de agendamentos de conteúdo
content-schedule-group-controllerGestão de grupos de agendamentos de conteúdo
message-schedule-controllerGestão de agendamentos de mensagens
message-schedule-group-controllerGestão de grupos de agendamentos de mensagens
Dispositivodevice-controllerGestão de dispositivos
device-group-controllerGestão de grupos de dispositivos
Utilizadoruser-controllerGestão de utilizadores
user-group-controllerGestão de grupos de utilizadores
Definiçãoenvironment-controllerDefinição

Conteúdo

Pode carregar, aprovar e eliminar conteúdo. Também pode fazer a gestão de listas de conteúdo.  Os 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 chamadaDescrição
listAllContent

/restapi/v1.0/cms/contents

GETPermite 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

GETPermite importar informações gerais sobre o conteúdo que será apresentado no painel de controlo.
listContent

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

POSTPermite 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}

DELETEPermite 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}

DELETEPermite 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}

GETPermite 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

PUTPermite 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}

POSTPermite carregar conteúdo novo.

listDefaultGroup

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

GETPermite importar uma lista de grupos de conteúdo predefinido.
getGroup

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

GETPermite importar detalhes do grupo {groupId}.
listChildGroup

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

GETPermite 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 chamadaDescrição
listAllPlaylist

/restapi/v1.0/cms/playlists

GETPermite 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

POSTPermite criar uma nova lista de reprodução.

getDashboardPlaylistInfo

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

GETPermite importar informações necessárias sobre a lista de reprodução a partir do painel de controlo.

listPlaylist

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

POSTPermite 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}

DELETEPermite 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}

GETPermite 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}

PUTPermite 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

PUTPermite copiar a lista de reprodução {playlistId}. É criada uma cópia duplicada da lista de reprodução.
listDefaultGroup

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

GETPermite importar uma lista de grupos de listas de reprodução predefinidas.

getGroup

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

GETPermite importar detalhes do grupo {groupId}.
listChildGroup/restapi/v1.0/cms/playlists/groups/{groupId}/childGET

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 chamadaDescrição
listContentScheduleAll

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

GETPermite 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

POSTPermite 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

GETPermite 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

POSTPermite 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}

DELETEPermite 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}

GETPermite importar detalhes do agendamento selecionado.
editContentSchedule

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

PUTPermite 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

PUTPermite 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

PUTPermite publicar um agendamento de conteúdo num grupo de dispositivos específico.
getPublishStatus

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

GETPermite 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

GETPermite importar uma lista de grupos de raiz para um agendamento de conteúdo.
listContentScheduleGroupInfo/restapi/v1.0/dms/schedule/contents/groups/{groupId}GETPermite importar detalhes do grupo {groupId}.
listAllMessageSchedule

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

GETPermite importar uma lista de todos os agendamentos de mensagens.
createMessageSchedule

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

POSTPermite 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}

DELETEPermite 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}

GETPermite importar detalhes do agendamento de mensagens selecionado.
editMessageSchedule

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

PUTPermite 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

PUTPermite copiar o agendamento de mensagens selecionado. É criada uma cópia duplicada do agendamento de mensagens.
deployMessageSchedule

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

PUTPermite publicar o agendamento de mensagens selecionado num grupo de dispositivos.
getRootGroups

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

GETPermite importar uma lista de grupos de raiz para um agendamento de conteúdo.
listMessageScheduleGroupInfo

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

GETPermite importar detalhes do grupo {groupId}.
getChildGroups

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

GETPermite 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 chamadaDescrição
listAllDevice

/restapi/v1.0/rms/devices

GETPermite 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

GETPermite importar informações necessárias sobre o dispositivo a partir do painel de controlo.
filterDeviceList

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

POSTPermite 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}

DELETEPermite eliminar o dispositivo selecionado.
getDevice

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

GETPermite importar detalhes do dispositivo selecionado.
approveDevice

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

PUTPermite aprovar o dispositivo selecionado para um grupo específico.
getCabinetList

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

POSTPermite 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

PUTPermite editar informações sobre cabinets ligados a um dispositivo LED.
getDisplayControlInfo

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

GETPermite 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

PUTPermite 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}

GETPermite 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

GETPermite 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

PUTPermite 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}

GETPermite 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

PUTPermite mover um dispositivo para outro grupo.
startRmServerVnc

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

GETPermite 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

GETPermite 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

GETPermite 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

PUTPermite 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}

GETPermite 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

GETPermite 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}

GETPermite 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

GETPermite 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}

GETPermite 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

GETPermite 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

PUTPermite 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

GETPermite importar uma lista de organizações.
listDeviceGroupInfo

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

GETPermite importar detalhes do grupo {groupId}.
listDeviceGroupChild

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

GETPermite importar informações sobre subgrupos de {groupId}.

Utilizador

Pode adicionar utilizadores e gerir informações dos mesmos.  Os 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 chamadaDescrição
createUser/restapi/v1.0/ums/usersPOSTPermite adicionar um utilizador.
listDashboardUserInfo

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

GETPermite importar informações necessárias sobre utilizadores a partir do painel de controlo.
updateMyInfo

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

PUTPermite editar informações de utilizadores.
listUserOrgan

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

GETPermite 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

GETPermite importar uma lista de organizações.
listUserGroupInfo

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

GETPermite importar detalhes do grupo {groupId}.
listUserGroupChild

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

GETPermite 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 chamadaDescrição
getCategoryInfo

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

GETPermite importar uma lista de categorias.
deleteDashboard

/restapi/v1.0/ems/dashboard

DELETEPermite eliminar informações de painel de controlo específicas.
listDashboardInfo

/restapi/v1.0/ems/dashboard

GETPermite 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

PUTPermite alterar a ordem dos itens apresentados no painel de controlo.
createDashboard

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

GETPermite ativar um painel de controlo inativo.

listDashboardLoginInfo

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

GETPermite importar informações de início de sessão que serão apresentadas no painel de controlo.
listDashboardNoticeInfo

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

GETPermite importar informações de quadro de avisos que serão apresentadas no painel de controlo.
deleteNoticeInfo

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

DELETEPermite eliminar uma publicação de um quadro de avisos.
listEditNoticeInfo

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

GETPermite importar detalhes da publicação selecionada.
createNoticeInfo

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

POSTPermite adicionar publicações ao quadro de avisos.
updateNoticeInfo

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

PUTPermite editar a publicação selecionada no quadro de avisos.
listDashboardStorageInfo

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

GETPermite importar informações de armazenamento que serão apresentadas no painel de controlo.

listLicense

/restapi/v1.0/ems/license

GETPermite importar uma lista de licenças registadas no servidor.
getServerSetupInfo

/restapi/v1.0/ems/setup

GETPermite 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

POSTPermite 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
languagetr


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ı çağrı TürüAçıklama
authenticationRequest

/auth

POSTKullanıcı kimliği ve parolasını kullanarak kimlik denetimi için bir belirteç değeri içeri aktarır.
authenticationRequest

/auth/refresh

GETGeç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.

KategoriDenetleyiciAçıklama
İçerikcontent-controllerİçerik dosyası yönetimi
content-group-controllerİçerik grubu yönetimi
Oynatma listesiplaylist-controllerBir çalma listesinin yönetilmesi
playlist-group-controllerÇalma çalma listesi grubu yönetimi
Zamanlamacontent-schedule-controllerİçerik zamanlaması yönetimi
content-schedule-group-controllerİçerik zamanlaması grubu yönetimi
message-schedule-controllerMesaj zamanlaması yönetimi
message-schedule-group-controllerMesaj zamanlaması grubu yönetimi
Aygıtdevice-controllerAygıt yönetimi
device-group-controllerAygıt grubu yönetimi
Kullanıcıuser-controllerKullanıcı yönetimi
user-group-controllerKullanıcı grubu yönetimi
Ayarenvironment-controllerAyar

İç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ı çağrı TürüAçıklama
listAllContent

/restapi/v1.0/cms/contents

GETKarşı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

GETKontrol panelinde gösterilecek genel içerik bilgilerini içeri aktarır.
listContent

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

POSTKoş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}

POSTYeni içeriği karşıya yükler.

listDefaultGroup

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

GETVarsayı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 ç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ı çağrı TürüAçıklama
listAllPlaylist

/restapi/v1.0/cms/playlists

GETTü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

POSTYeni bir çalma listesi oluşturur.

getDashboardPlaylistInfo

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

GETKontrol panelinden gerekli çalma listesi bilgilerini içeri aktarır.

listPlaylist

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

POSTKoş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}

DELETESeç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 çalma listesinin aktifleştirilmiş bir sürümünün detaylarını içeri aktarır. Çalma ç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 çalma listesinin bir kopyası oluşturulur.
listDefaultGroup

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

GETVarsayı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}/childGET

{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ı ç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

POSTYeni 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

GETKontrol panelinden gerekli içerik zamanlama bilgilerini içeri aktarır.
listContentScheduleByGroup

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

POSTFarklı 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}

GETSeç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

GETGerç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

GETTüm mesaj zamanlamalarının listesini içeri aktarır.
createMessageSchedule

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

POSTYeni 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}

DELETESeç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}

GETSeçilen mesaj zamanlamasının detaylarını içeri aktarır.
editMessageSchedule

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

PUTSeç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

PUTSeçilen mesaj zamanlamasını kopyalar. Mesaj zamanlamasının bir kopyası oluşturulur.
deployMessageSchedule

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

PUTSeç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

GETBelirli 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ı çağrı TürüAçıklama
listAllDevice

/restapi/v1.0/rms/devices

GETTü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

GETKontrol panelinden gerekli aygıt bilgilerini içeri aktarır.
filterDeviceList

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

POSTFarklı 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}

DELETESeçilen aygıtı siler.
getDevice

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

GETSeçilen aygıtın detaylarını içeri aktarır.
approveDevice

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

PUTSeçilen aygıtı belirli bir grup için onaylar.
getCabinetList

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

POSTLED 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

PUTLED aygıtına bağlanmış cabinet'ler hakkındaki bilgileri düzenler.
getDisplayControlInfo

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

GETVeri 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

PUTDü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}

GETAygı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

GETVeri 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

PUTDü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}

GETAygı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

PUTAygıtı farklı bir gruba taşır.
startRmServerVnc

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

GETAygı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

GETRM 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

GETAygı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

PUTDü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}

GETAygı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

GETAygı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}

GETAygı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

GETAygı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}

GETAygı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

GETVeritabanı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

PUTAygı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

GETOrganizasyonları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ı çağrı TürüAçıklama
createUser/restapi/v1.0/ums/usersPOSTKullanıcı ekler.
listDashboardUserInfo

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

GETKontrol panelinden gerekli kullanıcı bilgilerini içeri aktarır.
updateMyInfo

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

PUTKullanıcı bilgisini düzenler.
listUserOrgan

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

GETOrganizasyonları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

GETOrganizasyonları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ı çağrı TürüAçıklama
getCategoryInfo

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

GETKategorilerin listesini içeri aktarır.
deleteDashboard

/restapi/v1.0/ems/dashboard

DELETEBelirli bir kontrol paneli bilgisini siler.
listDashboardInfo

/restapi/v1.0/ems/dashboard

GETÖzelleştirilmiş ö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

PUTKontrol panelinde gösterilen öğelerin sıralamasını değiştirir.
createDashboard

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

GETBoştaki bir kontrol panelini aktifleştirir.

listDashboardLoginInfo

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

GETKontrol panelinde gösterilecek giriş bilgilerini içeri aktarır.
listDashboardNoticeInfo

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

GETKontrol 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

GETSeç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

GETKontrol panelinde gösterilecek depolama bilgilerini içeri aktarır.

listLicense

/restapi/v1.0/ems/license

GETSunucudaki kayıtlı lisansların listesini içeri aktarır.
getServerSetupInfo

/restapi/v1.0/ems/setup

GETSunucu 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

POSTSunucuda 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
languagesv


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

AnropstypBeskrivning
authenticationRequest

/auth

POSTImporterar ett token-värde för autentisering med hjälp av användar-ID:t och lösenordet.
authenticationRequest

/auth/refresh

GETSkapar 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.

KategoriStyrenhetBeskrivning
Innehållcontent-controllerHantering av innehåll
content-group-controllerHantering av innehållsgrupper
Spellistaplaylist-controllerHantera spellistor
playlist-group-controllerHantering av spellistegrupper
Schemacontent-schedule-controllerHantering av innehållsscheman
content-schedule-group-controllerHantering av grupper av innehållsscheman
message-schedule-controllerHantering av meddelandescheman
message-schedule-group-controllerHantering av grupper av meddelandescheman
Enhetdevice-controllerEnhetshantering
device-group-controllerHantering av enhetsgrupper
Användareuser-controllerAnvändarhantering
user-group-controllerHantering av användargrupper
Inställningenvironment-controllerInställning

Innehåll

Överföraö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

AnropstypBeskrivning
listAllContent

/restapi/v1.0/cms/contents

GETImporterar 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

GETImporterar allmän innehållsinformation som ska visas på instrumentpanelen.
listContent

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

POSTImporterar 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}

DELETETar bort innehållet, oavsett om innehållet ingår i en spellista eller ett schema.
deleteContent

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

DELETETar 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}

GETImporterar 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

PUTGodkä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 överför nytt innehåll.

listDefaultGroup

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

GETImporterar en lista med standardinnehållsgrupper.
getGroup

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

GETImporterar information om gruppen {groupId}.
listChildGroup

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

GETImporterar 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

AnropstypBeskrivning
listAllPlaylist

/restapi/v1.0/cms/playlists

GETImporterar 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

POSTSkapa en ny spellista.

getDashboardPlaylistInfo

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

GETImporterar nödvändig spellisteinformation från instrumentpanelen.

listPlaylist

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

POSTImporterar 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}

DELETETa 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}

GETImporterar information om en aktiverad version av en spellista. Spellistans version uppdateras varje gång spellistan redigeras.

editPlaylist

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

PUTRedigerar 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

PUTKopierar spellistan {playlistId}. En kopia av spellistan skapas.
listDefaultGroup

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

GETImporterar en lista med grupper av standardspellistor.

getGroup

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

GETImporterar information om gruppen {groupId}.
listChildGroup/restapi/v1.0/cms/playlists/groups/{groupId}/childGET

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

AnropstypBeskrivning
listContentScheduleAll

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

GETImporterar 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

POSTSkapar 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

GETImport nödvändig innehållsschemainformation från instrumentpanelen.
listContentScheduleByGroup

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

POSTImporterar 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}

DELETETa 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}

GETImporterar information om det markerade schemat.
editContentSchedule

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

PUTRedigerar 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

PUTKopierar innehållsschemat {programId}. En kopia av innehållsschemat {programId} skapas.
deployContentSchedule

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

PUTPublicerar ett innehållsschema till en specifik enhetsgrupp.
getPublishStatus

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

GETImporterar hämtningsstatus för innehållsscheman i realtid från en enhet.
getRootGroups

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

GETImporterar en lista med rotgrupper för ett innehållsschema.
listContentScheduleGroupInfo/restapi/v1.0/dms/schedule/contents/groups/{groupId}GETImporterar information om gruppen {groupId}.
listAllMessageSchedule

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

GETImporterar en lista med samtliga meddelandescheman.
createMessageSchedule

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

POSTSkapar 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}

DELETETar 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}

GETImporterar information om det markerade meddelandeschemat.
editMessageSchedule

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

PUTRedigerar 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

PUTKopierar det markerade meddelandeschemat. En kopia av meddelandeschemat skapas.
deployMessageSchedule

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

PUTPublicerar det markerade meddelandeschemat till en enhetsgrupp.
getRootGroups

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

GETImporterar en lista med rotgrupper för ett innehållsschema.
listMessageScheduleGroupInfo

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

GETImporterar information om gruppen {groupId}.
getChildGroups

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

GETImporterar 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

AnropstypBeskrivning
listAllDevice

/restapi/v1.0/rms/devices

GETImporterar 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

GETImporterar nödvändig enhetsinformation från instrumentpanelen.
filterDeviceList

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

POSTImporterar 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}

DELETETar bort den markerade enheten.
getDevice

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

GETImporterar information om markerade enheter.
approveDevice

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

PUTGodkänner den markerade enheten för en specifik grupp.
getCabinetList

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

POSTImporterar 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

PUTRedigerar information om Cabinet som är anslutna till en LED-enhet.
getDisplayControlInfo

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

GETImporterar 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

PUTSkickar 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}

GETTar 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

GETImporterar 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

PUTSkickar 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}

GETTar 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

PUTFlyttar en enhet till en annan grupp.
startRmServerVnc

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

GETSkickar 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

GETSkickar 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

GETImporterar enhetsinställningar. Enhetens inställningar uppdateras när enheten ansluts till servern.
updateSetupInfo

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

PUTSkickar 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}

GETTar 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

GETSkickar 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}

GETImporterar 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

GETSkickar 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}

GETImporterar 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

GETImporterar 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

PUTSkickar 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

GETImporterar en lista med organisationer.
listDeviceGroupInfo

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

GETImporterar information om gruppen {groupId}.
listDeviceGroupChild

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

GETImporterar 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

AnropstypBeskrivning
createUser/restapi/v1.0/ums/usersPOSTLägger till en användare.
listDashboardUserInfo

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

GETImporterar nödvändig användarinformation från instrumentpanelen.
updateMyInfo

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

PUTRedigerar användarinformation.
listUserOrgan

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

GETImporterar 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

GETImporterar en lista med organisationer.
listUserGroupInfo

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

GETImporterar information om gruppen {groupId}.
listUserGroupChild

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

GETImporterar 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

AnropstypBeskrivning
getCategoryInfo

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

GETImporterar en lista med kategorier.
deleteDashboard

/restapi/v1.0/ems/dashboard

DELETETar bort specifik instrumentpanelsinformation.
listDashboardInfo

/restapi/v1.0/ems/dashboard

GETImporterar 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 ändrar ordning på de objekt som visas på instrumentpanelen.
createDashboard

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

GETAktiverar en inaktiv instrumentpanel.

listDashboardLoginInfo

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

GETImporterar inloggningsinformation som ska visas på instrumentpanelen.
listDashboardNoticeInfo

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

GETImporterar anslagstavleinformation som ska visas på instrumentpanelen.
deleteNoticeInfo

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

DELETETar bort ett inlägg från anslagstavlan.
listEditNoticeInfo

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

GETImporterar information om det markerade inlägget.
createNoticeInfo

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

POSTLägger till inlägg på anslagstavlan.
updateNoticeInfo

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

PUTRedigerar det markerade inlägget på anslagstavlan.
listDashboardStorageInfo

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

GETImporterar lagringsinformation som ska visas på instrumentpanelen.

listLicense

/restapi/v1.0/ems/license

GETImporterar en lista med licenser som registrerats på servern.
getServerSetupInfo

/restapi/v1.0/ems/setup

GETImporterar serverinställningar. Serverinställningsobjekt inkluderar alternativ som kan slå på och av olika funktioner på servern.
getTagListInfo

/restapi/v1.0/ems/tag

POSTImporterar en lista med taggar som registrerats på servern.


Open API-information (swagger UI)

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