Versions Compared

Key

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

...

Sv translation
languagede

MagicINFO Server ermöglicht es Ihnen, Content Management, Terminmanagement, Gerätemanagement usw. zu implementieren, indem Sie Open API (v2.0) aufrufen. 

Für die Verwendung von Open API (v2.0) müssen Sie zuerst einen Authentifizierungsprozess durchlaufen. Verwenden Sie eine separate Swagger-Seite, um jedes einzelne API zu testen.

Authentifizierung

Beim Aufrufen aller Open API (v2.0)-Elemente muss api_token im Header enthalten sein. Wenn dies nicht enthalten ist, wird ein „401 Unauthorized.“-Fehler zurückgegeben.

Ein erhaltener Token läuft nach einem bestimmten Zeitraum ab und wird nicht mehr verfügbar. In diesem Fall sollten Sie einen neuen Token erhalten.

api_token können durch Aufrufen der folgenden Api abgerufen werden.

Name des Dienstes

API-Aufruf

Ereignistyp

Beschreibung

authenticationRequest

/auth

POST

Importiert einen Token-Wert für die Authentifizierung unter Verwendung der Benutzer-ID und des Kennworts.

authenticationRequest

/auth/refresh

GET

Erstellt ein neues Token, um die Ablaufzeit zu verlängern. Es ist möglich, REST API aufzurufen, ohne sich erneut anzumelden

OPEN API (v2.0)

MagicINFO Server Open API (v2.0) bietet eine Vielzahl von Funktionen. Die Konfiguration der einzelnen Funktionen wird unten dargestellt.

Kategorie

Controller

Beschreibung

Inhalt

content-controller

Content Management

content-group-controller

Inhaltsgruppen-Verwaltung

Wiedergabeliste

playlist-controller

Verwalten einer Wiedergabeliste

playlist-group-controller

Wiedergabelistengruppen-Verwaltung

Zeitplan

content-schedule-controller

Inhaltszeitplan-Verwaltung

content-schedule-group-controller

Inhaltszeitplan-Gruppenverwaltung

message-schedule-controller

Verwalten von Nachrichtenzeitplänen

message-schedule-group-controller

Nachrichten-Zeitplan-Gruppenverwaltung

Gerät

device-controller

Gerätemanagement

device-group-controller

Gerätegruppen-Verwaltung

Benutzer

user-controller

Benutzerverwaltung

user-group-controller

Benutzergruppen-Verwaltung

Einstellung

environment-controller

Einstellung

Inhalt

Hochladen, Genehmigen oder Löschen von Inhalten. Verwalten von Inhaltsdateizeitplänen Inhaltsbezogene Dienste sind für authentifizierte Benutzer mit Berechtigungen zum Lesen, Schreiben und Verwalten von Inhalten zugänglich.

Die folgenden Inhaltsverwaltungsdienste sind verfügbar:

Name des Dienstes

API-Aufruf

Ereignistyp

Beschreibung

listAllContent

/restapi/v1.0/cms/contents

GET

Importiert eine Liste mit hochgeladenen Inhalten. In der Liste sind Inhalts-Miniaturen, Namen, Dateitypen und andere grundlegende Informationen enthalten. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.

listDashboardContentInfo

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

GET

Importiert allgemeine Inhaltsinformationen, die auf dem Dashboard angezeigt werden.

listContent

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

POST

Importiert eine Liste mit anhand der Bedingungen gefilterten Inhalten. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.

forceDeleteContent

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

DELETE

Löscht Inhalte, unabhängig davon, ob die Inhalte in einer Wiedergabeliste oder einem Zeitplan enthalten sind.

deleteContent

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

DELETE

Löscht Inhalte, nachdem überprüft wurde, dass die Inhalte nicht in einer Wiedergabeliste oder einem Zeitplan enthalten sind. Wenn Sie versuchen, Inhalte zu löschen, die in einer Wiedergabeliste oder einem Zeitplan enthalten sind, werden die Inhalte nicht gelöscht und es wird ein Fehlercode zurückgegeben.

getActiveContentInfo

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

GET

Bei jedem Abändern des Inhalts wird die Version aktualisiert. Die aktive Version der Inhaltsangaben wird abgerufen.

approveContents

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

PUT

Genehmigt Inhalte/lehnt Inhalte ab. Genehmigte Inhalte werden in die allgemeine Inhaltsliste bewegt und können in Wiedergabelisten oder Zeitplänen verwendet werden.

uploadContent

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

POST

Lädt neue Inhalte hoch.

listDefaultGroup

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

GET

Importiert eine Liste der Standard-Inhaltsgruppen.

getGroup

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

GET

Abrufungsdetails der {groupId}-Gruppe.

listChildGroup

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

GET

Ruft eine Liste der Untergruppen unter der {groupId}-Gruppe ab.


Wiedergabeliste

Verwenden Sie Inhalte zum Erstellen, Bearbeiten oder Löschen von Wiedergabelisten. Wiedergabelistenbezogene Dienste sind für authentifizierte Benutzer mit Berechtigungen zum Lesen, Schreiben und Verwalten von Inhalten zugänglich.

Die folgenden Wiedergabelistenverwaltungsdienste sind verfügbar:

Name des Dienstes

API-Aufruf

Ereignistyp

Beschreibung

listAllPlaylist

/restapi/v1.0/cms/playlists

GET

Importiert eine Liste mit allen Wiedergabelisten. In der Liste sind Namen von Wiedergabelisten, Miniaturen von Hauptinhalten, Typen von Wiedergabelisten und andere grundlegende Informationen enthalten. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.

createPlaylist

/restapi/v1.0/cms/playlists

POST

Erstellt eine neue Wiedergabeliste.

getDashboardPlaylistInfo

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

GET

Importiert notwendige Wiedergabelisteninformationen vom Dashboard.

listPlaylist

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

POST

Importiert eine Liste mit anhand der Bedingungen gefilterten Wiedergabelisten. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.

deletePlaylist

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

DELETE

Löscht die ausgewählte Wiedergabeliste. Wenn Sie versuchen, eine Wiedergabeliste zu löschen, die in einem Zeitplan enthalten ist, wird die Wiedergabeliste nicht gelöscht und es wird ein Fehlercode zurückgegeben.

getActivePlaylistInfo

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

GET

Importiert Details einer aktivierten Version einer Wiedergabeliste. Die Version einer Wiedergabeliste wird jedes Mal aktualisiert, wenn die Wiedergabeliste bearbeitet wird.

editPlaylist

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

PUT

Ändert die {playlistId}-Wiedergabeliste ab. Das Bearbeiten einer Wiedergabeliste aktualisiert die Wiedergabelistenversion und bewirkt, dass das Gerät, das die Wiedergabeliste abspielt, die aktualisierte Wiedergabeliste automatisch abspielt.

copyPlaylist

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

PUT

Kopiert die {playlistId}-Wiedergabeliste. Ein Duplikat der Wiedergabeliste wurde erstellt.

listDefaultGroup

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

GET

Importiert eine Liste der Standard-Wiedergabelistengruppen.

getGroup

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

GET

Abrufungsdetails der {groupId}-Gruppe.

listChildGroup

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

GET

Ruft eine Liste der Untergruppen unter der {groupId}-Gruppe ab.

Zeitplan

Neue Inhalte oder Nachrichtenzeitpläne erstellen. Zeitpläne an Geräte für die Wiedergabe übermitteln. Zeitpläne löschen oder bearbeiten.

Den Zeitplan betreffende Dienste sind für authentifizierte Benutzer mit Berechtigungen zum Lesen, Schreiben und Verwalten von Zeitplänen zugänglich.

Die folgenden Zeitplanverwaltungsdienste sind verfügbar:

Name des Dienstes

API-Aufruf

Ereignistyp

Beschreibung

listContentScheduleAll

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

GET

Importiert eine Liste aller Inhaltszeitpläne. In der Liste sind Namen von Inhaltszeitplänen, Erstellungsdaten und andere grundlegenden Informationen enthalten. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.

createContentSchedule

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

POST

Erstellt einen neuen Inhaltszeitplan. Ein Inhaltszeitplan kann mehrere Kanäle und Rahmen enthalten. Einen Zeitplan an Geräte übermitteln und die gewünschten Inhalte oder die Wiedergabeliste zu einer bestimmten Zeit wiedergeben.

listDashboardScheduleInfo

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

GET

Importiert notwendige Inhaltszeitplaninformationen vom Dashboard.

listContentScheduleByGroup

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

POST

Importiert eine Liste mit anhand der unterschiedlichen Bedingungen gefilterten Inhaltszeitplänen. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.

deleteContentSchedule

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

DELETE

Löscht einen Inhaltszeitplan. Wenn ein Zeitplan gelöscht wird, der zuvor an ein Gerät übermittelt wurde, spielt das Gerät automatisch die Standard-Inhalte ab.

getProgramInfo

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

GET

Importiert Details des ausgewählten Zeitplans.

editContentSchedule

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

PUT

Bearbeitet einen Inhaltszeitplan. Wenn ein Zeitplan bearbeitet wird, der zuvor an ein Gerät übermittelt wurde, spielt das Gerät automatisch den bearbeiteten Zeitplan ab.

copyContentSchedule

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

PUT

Kopiert den {programId}-Inhaltszeitplan. Der Inhaltszeitplan, wie etwa {programId}, wird neu erstellt.

deployContentSchedule

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

PUT

Übermittelt einen Inhaltszeitplan an eine bestimmte Gerätegruppe.

getPublishStatus

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

GET

Import den Echtzeit-Inhaltszeitplan-Downloadstatus von einem Gerät.

getRootGroups

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

GET

Importiert eine Liste mit Root-Gruppen für einen Inhaltszeitplan.

listContentScheduleGroupInfo

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

GET

Abrufungsdetails der {groupId}-Gruppe.

listAllMessageSchedule

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

GET

Importiert eine Liste aller Nachrichtenzeitpläne.

createMessageSchedule

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

POST

Erstellt einen neuen Nachrichtenzeitplan.

listMessage

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

POST

Importiert eine Liste mit anhand der unterschiedlichen Bedingungen gefilterten Nachrichtenzeitpläne. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.

deleteMessageSchedule

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

DELETE

Löscht den ausgewählten Nachrichtenzeitplan. Wenn ein Nachrichtenzeitplan gelöscht wird, der zuvor an ein Gerät übermittelt wurde, wird die Änderung automatisch auf das Gerät angewendet.

getMessageInfo

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

GET

Importiert Details des ausgewählten Nachrichtenzeitplans.

editMessageSchedule

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

PUT

Bearbeitet den ausgewählten Nachrichtenzeitplan. Wenn ein Nachrichtenzeitplan bearbeitet wird, der zuvor an ein Gerät übermittelt wurde, wird die Änderung automatisch auf das Gerät angewendet.

copyMessageSchedule

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

PUT

Kopiert den ausgewählten Nachrichtenzeitplan. Ein Duplikat des Nachrichtenzeitplans wird erstellt.

deployMessageSchedule

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

PUT

Übermittelt den ausgewählten Nachrichtenzeitplan an eine Gerätegruppe.

getRootGroups

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

GET

Importiert eine Liste mit Root-Gruppen für einen Inhaltszeitplan.

listMessageScheduleGroupInfo

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

GET

Abrufungsdetails der {groupId}-Gruppe.

getChildGroups

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

GET

Importiert eine Liste der Untergruppen unter einer bestimmten Gruppe.

Gerät

Geräte steuern und verwalten. Gerätebezogene Dienste sind für authentifizierte Benutzer mit Berechtigungen zum Lesen, Schreiben und Verwalten von Geräten zugänglich.

Die folgenden Geräteverwaltungsdienste sind verfügbar:

Name des Dienstes

API-Aufruf

Ereignistyp

Beschreibung

listAllDevice

/restapi/v1.0/rms/devices

GET

Importiert eine Liste mit allen Geräten. Gerät-Energieversorgungsstatus, Miniaturansichtsinformationen, Gerätefehlerstatus und andere grundlegende Informationen sind in der Liste enthalten. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.

getDashboardDeviceInfo

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

GET

Importiert notwendige Geräteinformationen aus dem Dashboard.

filterDeviceList

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

POST

Importiert eine Liste mit anhand der unterschiedlichen Bedingungen gefilterten Geräten. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.

deleteDevice

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

DELETE

Löscht das ausgewählte Gerät.

getDevice

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

GET

Importiert Details des ausgewählten Geräts.

approveDevice

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

PUT

Genehmigt das ausgewählte Video für eine bestimmte Gruppe.

getCabinetList

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

POST

Importiert Informationen über Schränke, die mit einem LED-Gerät verbunden sind. Die importierten Informationen gelten nur, wenn die Schränke mit einem LED-Gerät verbunden sind.

updateCabinetInfo

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

PUT

Bearbeitet Informationen über Schränke, die mit einem LED-Gerät verbunden sind.

getDisplayControlInfo

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

GET

Importiert Geräteanzeigesteuerungsinformationen aus der Datenbank. Falls keine Steuerungsinformationen vorhanden sind, sollte eine Informationsanfrage an das Gerät gesendet werden.

updateDisplayInfo

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

PUT

Sendet bearbeitete Anzeigesteuerungsinformationen an ein Gerät. Nur bearbeitete Werte in den Anzeigeinformationen werden als Protokoll an das Gerät gesendet.

getUpdatedDisplayInfoResult

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

GET

Empfängt bearbeitete Anzeigesteuerungsinformationen von einem Gerät. Diese API ist nach dem Ausführen der updateDisplayInfo-API ausführbar.

getGeneralInfo

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

GET

Importiert allgemeine Geräteinformationen aus der Datenbank. Allgemeine Geräteinformationen werden aktualisiert, wenn sich das Gerät mit dem Server verbindet.

updateGeneralInfo

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

PUT

Sendet bearbeitete Geräteinformationen an ein Gerät. Nur bearbeitete Werte in grundlegenden Geräteinformationen werden als Protokoll an das Gerät gesendet.

getUpdatedGeneralInfoResult

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

GET

Erhält bearbeitete Geräteinformationen von einem Gerät. Diese API ist nach dem Ausführen der updateGeneralInfo-API ausführbar.

moveDevice

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

PUT

Bewegt ein Gerät in eine andere Gruppe.

startRmServerVnc

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

GET

Sendet ein RM-Startprotokoll an ein Gerät. Ein Gerät, das ein RM-Startprotokoll empfangen hat, sendet in regelmäßigen Abständen Informationen über den Fernbedienungs-Server.

stopRmServerVnc

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

GET

Sendet ein RM-Stoppprotokoll an ein Gerät. Ein Gerät, das ein Stoppprotokoll empfangen hat, stoppt sofort die entsprechende Funktion.

getSetupInfo

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

GET

Importiert Geräteeinstellungen. Geräteeinstellungen werden aktualisiert, wenn sich das Gerät mit dem Server verbindet.

updateSetupInfo

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

PUT

Sendet bearbeitete Geräteeinstellungen an ein Gerät. Nur bearbeitete Werte in den Einstellungen werden als Protokoll an das Gerät gesendet.

getUpdatedSetupInfoResult

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

GET

Erhält bearbeitete Geräteeinstellungen von einem Gerät. Diese API ist nach dem Ausführen der updateSetupInfo-API ausführbar.

getCurrentStatusDisplay

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

GET

Sendet eine aktuelle Anzeigesteuerungsinformationsanfrage an ein Gerät. Wenn Sie diese API aufgerufen, wird requestId als response-Wert zurückgegeben.

getCurrentStatusDisplay

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

GET

Importiert eine Anzeigesteuerungsinformation, die von einem Gerät gesendet wurde. Diese Option wird für zwei Aktionen verwendet: Das Senden einer Anforderung für Informationen an ein Gerät und das Empfangen von tatsächlichen Geräteinformationen.

getCurrentStatusTime

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

GET

Sendet eine aktuelle Zeitinformationsanfrage an ein Gerät. Wenn Sie diese API aufgerufen, wird requestId als response-Wert zurückgegeben.

getCurrentStatusTime

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

GET

Importiert Zeitinformationen, die von einem Gerät gesendet wurden. Die requestId, die bei einer Anfrage bei getCurrentStatusTime erhalten wurde, muss als Parameter gesendet werden.

getTimeInfo

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

GET

Importiert Gerätezeitinformationen aus der Datenbank. Falls keine Steuerungsinformationen vorhanden sind, sollte eine Informationsanfrage an das Gerät gesendet werden.

updateTimeInfo

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

PUT

Sendet bearbeitete Zeitinformationen an ein Gerät. Nur bearbeitete Werte in den Zeitinformationen werden als Protokoll an das Gerät gesendet.

getUpdatedTimeInfoResult

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

GET

Erhält bearbeitete Zeitinformationen von einem Gerät. Diese API ist nach dem Ausführen der getUpdatedTimeInfoResult-API ausführbar.

listDeviceGroupOrgan

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

GET

Importiert eine Liste der Organisationen.

listDeviceGroupInfo

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

GET

Abrufungsdetails der {groupId}-Gruppe.

listDeviceGroupChild

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

GET

Ruft Untergruppen unter {groupId} ab.

Benutzer

Benutzer hinzufügen und Benutzerinformationen verwalten. Benutzerbezogene Dienste sind für authentifizierte Benutzer mit Berechtigungen zum Lesen, Schreiben und Verwalten von Benutzerinformationen zugänglich.

Die folgenden Benutzerverwaltungsdienste sind verfügbar:

Name des Dienstes

API-Aufruf

Ereignistyp

Beschreibung

createUser

/restapi/v1.0/ums/users

POST

Fügt einen Benutzer hinzu.

listDashboardUserInfo

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

GET

Importiert notwendige Benutzerinformationen aus dem Dashboard.

updateMyInfo

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

PUT

Bearbeitet Benutzerinformationen.

listUserOrgan

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

GET

Importiert eine Liste der Organisationen. Diese Option kann verwendet werden, um eine Gruppenstruktur zu konfigurieren.

listUserGroupOrgan

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

GET

Importiert eine Liste der Organisationen.

listUserGroupInfo

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

GET

Abrufungsdetails der {groupId}-Gruppe.

listUserGroupChild

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

GET

Ruft eine Liste der Untergruppen unter der {groupId}-Gruppe ab.

Einstellung

Neben den Hauptfunktionen können Sie viele weitere Funktionen zum Erstellen und Verwalten von Tags und Kategorien verwenden und das Dashboard bearbeiten.

Name des Dienstes

API-Aufruf

Ereignistyp

Beschreibung

getCategoryInfo

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

GET

Importiert eine Liste der Kategorien.

deleteDashboard

/restapi/v1.0/ems/dashboard

DELETE

Löscht bestimmte Dashboard-Informationen.

listDashboardInfo

/restapi/v1.0/ems/dashboard

GET

Importiert Inhalte, die auf dem angepassten Dashboard angezeigt werden. Es ist möglich, nur bestimmte Informationen auf dem Dashboard anzuzeigen.

updateDashboardPriority

/restapi/v1.0/ems/dashboard

PUT

Ändert die Reihenfolge der Elemente, die auf dem Dashboard angezeigt werden.

createDashboard

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

GET

Aktiviert ein inaktives Dashboard.

listDashboardLoginInfo

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

GET

Importiert Anmeldeinformationen, die auf dem Dashboard angezeigt werden.

listDashboardNoticeInfo

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

GET

Importiert Anzeigetafel-Informationen, die auf dem Dashboard angezeigt werden.

deleteNoticeInfo

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

DELETE

Löscht einen Beitrag von der Anzeigetafel.

listEditNoticeInfo

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

GET

Importiert Details des ausgewählten Beitrags.

createNoticeInfo

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

POST

Fügt einen Beitrag zur Anzeigetafel hinzu.

updateNoticeInfo

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

PUT

Bearbeitet den ausgewählten Beitrag auf der Anzeigetafel.

listDashboardStorageInfo

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

GET

Importiert Speicherinformationen, die auf dem Dashboard angezeigt werden.

listLicense

/restapi/v1.0/ems/license

GET

Importiert eine Liste der Lizenzen, die auf dem Server registriert werden.

getServerSetupInfo

/restapi/v1.0/ems/setup

GET

Importiert Servereinstellungen. Servereinstellelemente enthalten Optionen, die verschiedene Funktionen auf dem Server aktivieren oder deaktivieren können.

getTagListInfo

/restapi/v1.0/ems/tag

POST

Importiert eine Liste der Tags, die auf dem Server registriert werden.

Open API-Details (Swagger UI)

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

Sv translation
languageit

MagicINFO Server consente di implementare la gestione di contenuti, la gestione di programmi, la gestione di dispositivi e altre funzioni chiamando Open API (v2.0). 

Prima di poter usare Open API (v2.0) sarà necessario seguire un processo di autenticazione. Usare una pagina Swagger a parte per testare ciascuna API.

Autenticazione

Se si chiamano tutti gli elementi di Open API (v2.0), è necessario includere api_token nell'intestazione. Se non è incluso, viene restituito un errore "401 Unauthorized.".

I token ottenuti scadono e diventano indisponibili per l'uso dopo un determinato periodo di tempo. In tal caso, sarà necessario ottenere un nuovo token.

È possibile ottenere api_token chiamando la seguente api.

Nome servizio assistenza

Chiamata API

Tipo di chiamata

Descrizione

authenticationRequest

/auth

POST

Importa il valore di un token per l'autenticazione usando l'ID utente e la password.

authenticationRequest

/auth/refresh

GET

Crea un nuovo token per ampliare il tempo di scadenza. È possibile chiamare REST API senza effettuare nuovamente l'accesso

OPEN API (v2.0)

MagicINFO Server Open API (v2.0) fornisce diverse funzioni. Di seguito si mostra la configurazione di ciascuna funzione.

Categoria

Controller

Descrizione

Contenuto

content-controller

Gestione contenuti

content-group-controller

Gestione del gruppo di contenuti

Playlist

playlist-controller

Gestione di una playlist

playlist-group-controller

Gestione del gruppo di playlist

Programma

content-schedule-controller

Gestione programmazione di contenuti

content-schedule-group-controller

Gestione del gruppo di programmazioni di contenuti

message-schedule-controller

Gestione dei programmi messaggio

message-schedule-group-controller

Gestione del gruppo di programmazioni di messaggi

Dispositivo

device-controller

Gestione dispositivo

device-group-controller

Gestione del gruppo di dispositivi

Utente

user-controller

Gestione utente

user-group-controller

Gestione gruppo utente

Impostazioni

environment-controller

Impostazioni

Contenuto

Caricare, approvare o eliminare contenuto. Gestire elenchi di contenuti. Sono accessibili servizi relazionati con i contenuti per gli utenti autenticati con privilegi di lettura, scrittura e gestione di contenuti.

I servizi di gestione dei contenuti disponibili sono:

Nome servizio assistenza

Chiamata API

Tipo di chiamata

Descrizione

listAllContent

/restapi/v1.0/cms/contents

GET

Importa un elenco di contenuto aggiornato. Si includono nell'elenco anteprime di contenuti, nomi, tipi di file e altre informazioni di base. Gli elenchi possono essere importati per pagina, usando le informazioni di paging.

listDashboardContentInfo

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

GET

Importa le informazioni dei contenuti generali da visualizzare sulla dashboard.

listContent

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

POST

Importa un elenco di contenuti filtrato in base alle condizioni. Gli elenchi possono essere importati per pagina, usando le informazioni di paging.

forceDeleteContent

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

DELETE

Elimina contenuto, a prescindere dal fatto che sia incluso in una playlist o in una programmazione.

deleteContent

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

DELETE

Elimina contenuto dopo aver verificato che non è incluso in una playlist o in una programmazione. Se si cerca di eliminare del contenuto incluso in una playlist o in una programmazione, il contenuto non sarà eliminato e si restituirà un codice di errore.

getActiveContentInfo

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

GET

Ogni volta che si modifica il contenuto, viene aggiornata la relativa versione. La versione attiva dei dettagli del contenuto viene recuperata.

approveContents

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

PUT

Approva/respinge il contenuto. Il contenuto approvato viene spostato nell'elenco del contenuto generale e può essere usato in playlist e programmazioni.

uploadContent

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

POST

Esegue l'upload di contenuto nuovo.

listDefaultGroup

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

GET

Importa un elenco di gruppi di contenuti predefiniti.

getGroup

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

GET

Recupera i dettagli del gruppo {groupId}.

listChildGroup

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

GET

Recupera un elenco di sottogruppi nel gruppo {groupId}.


Playlist

Usare contenuto per creare, modificare o eliminare playlist. Sono accessibili servizi relazionati con le playlist per gli utenti autenticati con privilegi di lettura, scrittura e gestione di contenuti.

I servizi di gestione delle playlist disponibili sono:

Nome servizio assistenza

Chiamata API

Tipo di chiamata

Descrizione

listAllPlaylist

/restapi/v1.0/cms/playlists

GET

Importa un elenco di tutte le playlist. Si includono nell'elenco nomi di playlist, anteprime di contenuti principali, tipi di playlist e altre informazioni di base. Gli elenchi possono essere importati per pagina, usando le informazioni di paging.

createPlaylist

/restapi/v1.0/cms/playlists

POST

Crea una nuova playlist.

getDashboardPlaylistInfo

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

GET

Importa informazioni necessarie sulla playlist dalla dashboard.

listPlaylist

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

POST

Importa un elenco di playlist filtrato in base alle condizioni. Gli elenchi possono essere importati per pagina, usando le informazioni di paging.

deletePlaylist

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

DELETE

Elimina la playlist selezionata. Se si cerca di eliminare una playlist inclusa in una programmazione, la playlist non sarà eliminata e si restituirà un codice di errore.

getActivePlaylistInfo

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

GET

Importa dettagli di una versione attivata di una playlist. La versione di una playlist si aggiorna ogni volta che si modifica la playlist stessa.

editPlaylist

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

PUT

Modifica la playlist {playlistId}. Se si modifica una playlist si aggiorna la versione della playlist e, di conseguenza, il dispositivo che riproduce la playlist riproduce automaticamente la playlist aggiornata.

copyPlaylist

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

PUT

Copia la playlist {playlistId}. Si crea una copia duplicata della playlist.

listDefaultGroup

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

GET

Importa un elenco di gruppi di playlist predefinite.

getGroup

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

GET

Recupera i dettagli del gruppo {groupId}.

listChildGroup

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

GET

Recupera un elenco di sottogruppi nel gruppo {groupId}.

Programma

Creare nuove programmazioni di contenuto o messaggi. Pubblicare programmazioni sui dispositivi per la riproduzione. Modificare o eliminare programmazioni.

Sono accessibili servizi relazionati con le programmazioni per gli utenti autenticati con privilegi di lettura, scrittura e gestione di programmazioni.

I servizi di gestione delle programmazioni disponibili sono:

Nome servizio assistenza

Chiamata API

Tipo di chiamata

Descrizione

listContentScheduleAll

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

GET

Importa un elenco di tutte le programmazioni di contenuti. Si includono nell'elenco nomi di programmazioni di contenuti, date di creazione, tipi di dispositivi e altre informazioni di base. Gli elenchi possono essere importati per pagina, usando le informazioni di paging.

createContentSchedule

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

POST

Crea una nuova programmazione di contenuti. Una programmazione di contenuti può contenere vari canali e cornici. Pubblicare una programmazione sui dispositivi e riprodurre il contenuto desiderato o la playlist ad un'ora specificata.

listDashboardScheduleInfo

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

GET

Importa informazioni necessarie sulla programmazione di contenuti dalla dashboard.

listContentScheduleByGroup

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

POST

Importa un elenco di programmazioni di contenuti filtrato in base alle differenti condizioni. Gli elenchi possono essere importati per pagina, usando le informazioni di paging.

deleteContentSchedule

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

DELETE

Elimina una programmazione di contenuti. Se si elimina una programmazione precedentemente pubblicata su un dispositivo, il dispositivo riproduce automaticamente il contenuto predefinito.

getProgramInfo

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

GET

Importa dettagli della programmazione selezionata.

editContentSchedule

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

PUT

Modifica una programmazione di contenuti. Se si modifica una programmazione precedentemente pubblicata su un dispositivo, il dispositivo riproduce automaticamente la programmazione modificata.

copyContentSchedule

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

PUT

Copia il programma di contenuti {programId}. Viene creato il programma di contenuti,ad esempio {programId}.

deployContentSchedule

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

PUT

Pubblica una programmazione di contenuti su un gruppo specifico di dispositivi.

getPublishStatus

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

GET

Importa lo stato di download in tempo reale di una programmazione di contenuti dal dispositivo.

getRootGroups

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

GET

Importa un elenco di gruppi principali per una programmazione di contenuti.

listContentScheduleGroupInfo

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

GET

Recupera i dettagli del gruppo {groupId}.

listAllMessageSchedule

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

GET

Importa un elenco di tutte le programmazioni di messaggi.

createMessageSchedule

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

POST

Crea una nuova programmazione di messaggi.

listMessage

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

POST

Importa un elenco di programmazioni di messaggi filtrato in base alle differenti condizioni. Gli elenchi possono essere importati per pagina, usando le informazioni di paging.

deleteMessageSchedule

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

DELETE

Elimina la programmazione di messaggi selezionata. Se si elimina una programmazione di messaggi precedentemente pubblicata su un dispositivo, il cambio si applica automaticamente al dispositivo.

getMessageInfo

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

GET

Importa dettagli della programmazione di messaggi selezionata.

editMessageSchedule

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

PUT

Modifica la programmazione di messaggi selezionata. Se si modifica una programmazione di messaggi precedentemente pubblicata su un dispositivo, il cambio si applica automaticamente al dispositivo.

copyMessageSchedule

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

PUT

Copia la programmazione di messaggi selezionata. Si crea una copia duplicata della programmazione di messaggi.

deployMessageSchedule

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

PUT

Pubblica la programmazione di messaggi selezionata su un gruppo di dispositivi.

getRootGroups

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

GET

Importa un elenco di gruppi principali per una programmazione di contenuti.

listMessageScheduleGroupInfo

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

GET

Recupera i dettagli del gruppo {groupId}.

getChildGroups

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

GET

Importa un elenco di sottogruppi in un gruppo specifico.

Dispositivo

Controllare e gestire dispositivi. Sono accessibili servizi relazionati con i dispositivi per gli utenti autenticati con privilegi di lettura, scrittura e gestione di dispositivi.

I servizi di gestione dei dispositivi disponibili sono:

Nome servizio assistenza

Chiamata API

Tipo di chiamata

Descrizione

listAllDevice

/restapi/v1.0/rms/devices

GET

Importa un elenco di tutti i dispositivi. Si includono nell'elenco lo stato di alimentazione del dispositivo, info di anteprima, stato dell'errore del dispositivo e altre informazioni di base. Gli elenchi possono essere importati per pagina, usando le informazioni di paging.

getDashboardDeviceInfo

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

GET

Importa informazioni necessarie sul dispositivo dalla dashboard.

filterDeviceList

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

POST

Importa un elenco di dispositivi filtrato in base alle differenti condizioni. Gli elenchi possono essere importati per pagina, usando le informazioni di paging.

deleteDevice

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

DELETE

Elimina il dispositivo selezionato.

getDevice

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

GET

Importa dettagli del dispositivo selezionato.

approveDevice

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

PUT

Approva il dispositivo selezionato su un gruppo specifico.

getCabinetList

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

POST

Importa informazioni sui case collegati a un dispositivo LED. Le informazioni importate sono valide solo fino a quando il case è collegato a un dispositivo LED.

updateCabinetInfo

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

PUT

Modifica informazioni sui case collegati a un dispositivo LED.

getDisplayControlInfo

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

GET

Importa informazioni sul controllo della visualizzazione di un dispositivo dal database. Se non sono presenti informazioni sul controllo, si dovrà inviare al dispositivo una richiesta di informazioni.

updateDisplayInfo

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

PUT

Invia informazioni modificate sul controllo della visualizzazione a un dispositivo. Si inviano al dispositivo sotto forma di protocollo solo i valori modificati delle informazioni di visualizzazione.

getUpdatedDisplayInfoResult

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

GET

Riceve informazioni modificate sul controllo della visualizzazione da un dispositivo. Questa API viene eseguita dopo l'esecuzione dell'API updateDisplayInfo.

getGeneralInfo

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

GET

Importa informazioni generali sul dispositivo dal database. Le informazioni generali sul dispositivo vengono aggiornate quando si collega il dispositivo al server.

updateGeneralInfo

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

PUT

Invia informazioni modificate sul dispositivo a un dispositivo. Si inviano al dispositivo sotto forma di protocollo solo i valori modificati delle informazioni di base del dispositivo.

getUpdatedGeneralInfoResult

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

GET

Riceve informazioni modificate sul dispositivo da un dispositivo. Questa API viene eseguita dopo l'esecuzione dell'API updateGeneralInfo.

moveDevice

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

PUT

Sposta un dispositivo su un altro gruppo.

startRmServerVnc

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

GET

Invia un protocollo di avvio RM a un dispositivo. Un dispositivo che ha ricevuto il protocollo di avvio RM invia periodicamente le informazioni mediante il server di controllo remoto.

stopRmServerVnc

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

GET

Invia un protocollo di interruzione RM a un dispositivo. Il dispositivo che riceve il protocollo interruzione interrompe immediatamente la funzione corrispondente.

getSetupInfo

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

GET

Importa le impostazioni del dispositivo. Le impostazioni del dispositivo vengono aggiornate quando si collega il dispositivo al server.

updateSetupInfo

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

PUT

Invia impostazioni modificate del dispositivo a un dispositivo. Si inviano al dispositivo sotto forma di protocollo solo i valori modificati delle impostazioni.

getUpdatedSetupInfoResult

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

GET

Riceve impostazioni modificate del dispositivo da un dispositivo. Questa API viene eseguita dopo l'esecuzione dell'API updateSetupInfo.

getCurrentStatusDisplay

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

GET

Invia una richiesta di informazioni sul controllo della visualizzazione attuale a un dispositivo. Quando si chiama questa API, requestId viene restituito come valore response.

getCurrentStatusDisplay

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

GET

Importa informazioni sul controllo della visualizzazione inviate da un dispositivo. Questa opzione è usata per due azioni: inviare una richiesta di informazioni a un dispositivo e ricevere informazioni sul dispositivo reale.

getCurrentStatusTime

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

GET

Invia una richiesta di informazioni sull'orario attuale a un dispositivo. Quando si chiama questa API, requestId viene restituito come valore response.

getCurrentStatusTime

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

GET

Importa informazioni sull'orario inviate da un dispositivo. requestId ricevuto tramite la chiamata a getCurrentStatusTime deve essere inviato come parametro.

getTimeInfo

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

GET

Importa informazioni sull'orario di un dispositivo dal database. Se non sono presenti informazioni sul controllo, si dovrà inviare al dispositivo una richiesta di informazioni.

updateTimeInfo

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

PUT

Invia informazioni modificate sull'orario a un dispositivo. Si inviano al dispositivo sotto forma di protocollo solo i valori modificati delle informazioni sull'orario.

getUpdatedTimeInfoResult

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

GET

Riceve informazioni modificate sull'orario del dispositivo da un dispositivo. Questa API viene eseguita dopo l'esecuzione dell'API getUpdatedTimeInfoResult.

listDeviceGroupOrgan

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

GET

Importa un elenco di organizzazioni.

listDeviceGroupInfo

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

GET

Recupera i dettagli del gruppo {groupId}.

listDeviceGroupChild

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

GET

Recupera sottogruppi in {groupId}.

Utente

Aggiungere utenti e gestire le informazioni utente. Sono accessibili servizi relazionati con gli utenti per gli utenti autenticati con privilegi di lettura, scrittura e gestione di informazioni utente.

I servizi di gestione degli utenti disponibili sono:

Nome servizio assistenza

Chiamata API

Tipo di chiamata

Descrizione

createUser

/restapi/v1.0/ums/users

POST

Aggiunge un utente.

listDashboardUserInfo

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

GET

Importa informazioni necessarie sull'utente dalla dashboard.

updateMyInfo

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

PUT

Modifica le informazioni utente.

listUserOrgan

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

GET

Importa un elenco di organizzazioni. È possibile usare questa opzione per configurare un albero dei gruppi.

listUserGroupOrgan

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

GET

Importa un elenco di organizzazioni.

listUserGroupInfo

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

GET

Recupera i dettagli del gruppo {groupId}.

listUserGroupChild

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

GET

Recupera un elenco di sottogruppi nel gruppo {groupId}.

Impostazioni

Oltre alle funzioni principali, è possibile usare molte altre funzioni per creare e gestire tag e categorie e modificare la dashboard.

Nome servizio assistenza

Chiamata API

Tipo di chiamata

Descrizione

getCategoryInfo

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

GET

Importa un elenco di categorie.

deleteDashboard

/restapi/v1.0/ems/dashboard

DELETE

Elimina specifiche informazioni della dashboard.

listDashboardInfo

/restapi/v1.0/ems/dashboard

GET

Importa contenuti da visualizzare sulla dashboard personalizzata. È possibile visualizzare solo informazioni specifiche sulla dashboard.

updateDashboardPriority

/restapi/v1.0/ems/dashboard

PUT

Cambia l'ordine degli elementi visualizzati sulla dashboard.

createDashboard

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

GET

Attiva una dashboard inattiva.

listDashboardLoginInfo

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

GET

Importa le informazioni di accesso da visualizzare sulla dashboard.

listDashboardNoticeInfo

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

GET

Importa le informazioni della bacheca da visualizzare sulla dashboard.

deleteNoticeInfo

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

DELETE

Elimina una pubblicazione dalla bacheca.

listEditNoticeInfo

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

GET

Importa dettagli della pubblicazione selezionata.

createNoticeInfo

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

POST

Aggiunge pubblicazioni alla bacheca.

updateNoticeInfo

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

PUT

Modifica la pubblicazione selezionata sulla bacheca.

listDashboardStorageInfo

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

GET

Importa le informazioni di archiviazione da visualizzare sulla dashboard.

listLicense

/restapi/v1.0/ems/license

GET

Importa un elenco di licenze registrate sul server.

getServerSetupInfo

/restapi/v1.0/ems/setup

GET

Importa le impostazioni del server. Gli elementi di impostazione del server includono opzioni che possono attivare o disattivare funzioni diverse sul server.

getTagListInfo

/restapi/v1.0/ems/tag

POST

Importa un elenco di tag registrati sul server.

Dettagli Open API (swagger UI)

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