Page History

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

language	it

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
Contenuto	`content-group-controller`	Gestione del gruppo di contenuti
Playlist	`playlist-controller`	Gestione di una playlist
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
Dispositivo	`device-group-controller`	Gestione del gruppo di dispositivi
Utente	`user-controller`	Gestione utente
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

Sv translation

language	es

MagicINFO Server le permite implementar la administración de contenidos, de programaciones, de dispositivos y otras funciones mediante una llamada a Open API (versión 2.0).

Para utilizar Open API (versión 2.0), antes es necesario pasar por un proceso de autenticación. Use una página independiente de Swagger para probar cada API.

Autenticación

Si desea invocar todos los elementos de Open API (versión 2.0), se debe incluir api_token en el encabezado. Si no se incluye, se devuelve un error "401 Unauthorized.".

Un token obtenido caduca y deja de estar disponible para su uso después de un período de tiempo especificado. Si este es el caso, debe obtener un nuevo token.

Se puede obtener api_token invocando la siguiente API.

Nombre del servicio	Llamada de API	Tipo de llamada	Descripción
`authenticationRequest`	`/auth`	POST	Importa un valor de token para la autenticación utilizando el ID y la contraseña de usuario.
`authenticationRequest`	`/auth/refresh`	GET	Crea un nuevo token para prolongar el tiempo de caducidad. Es posible llamar a la API REST sin iniciar sesión otra vez.

OPEN API (v2.0)

La versión 2.0 de Open API que emplea MagicINFO Server ofrece una serie de funciones. A continuación se muestra la configuración de cada función.

Categoría	Controlador	Descripción
Contenido	`content-controller`	Gestión de archivos de contenido
Contenido	`content-group-controller`	Gestión de grupos de contenido
Lista de reproducción	`playlist-controller`	Gestión de listas de reproducción
Lista de reproducción	`playlist-group-controller`	Gestión de grupos de listas de reproducción
Programación	`content-schedule-controller`	Gestión de programaciones de contenidos
	`content-schedule-group-controller`	Gestión de grupos de programaciones de contenidos
	`message-schedule-controller`	Administración de la programación de mensajes
	`message-schedule-group-controller`	Gestión de grupos de programaciones de mensajes
Dispositivo	`device-controller`	Administración de dispositivos
Dispositivo	`device-group-controller`	Gestión de grupos de dispositivos
Usu.	`user-controller`	Administración de usuarios
Usu.	`user-group-controller`	Gestión de grupos de usuarios
Configuración	`environment-controller`	Configuración

Contenido

Cargar, aprobar o eliminar contenido. Gestionar listas de contenido. Los usuarios autenticados con privilegios para leer, escribir y gestionar contenidos pueden acceder a los servicios relacionados con el contenido.

Los servicios de gestión de contenidos disponibles son los siguientes:

Nombre del servicio	Llamada de API	Tipo de llamada	Descripción
`listAllContent`	`/restapi/v1.0/cms/contents`	GET	Importa una lista del contenido cargado. Las miniaturas de contenido, los nombres, los tipos de archivos y otra información básica se incluyen en la lista. Las listas se pueden importar por página mediante la información de paginación.
`listDashboardContentInfo`	`/restapi/v1.0/cms/contents/dashboard`	GET	Importa información general de contenido que se mostrará en el panel.
`listContent`	`/restapi/v1.0/cms/contents/filter`	POST	Importa una lista de contenido filtrado de acuerdo con condiciones. Las listas se pueden importar por página mediante la información de paginación.
`forceDeleteContent`	`/restapi/v1.0/cms/contents/force/{contentId}`	DELETE	Borra el contenido, tanto si está incluido en una lista de reproducción o una programación como si no.
`deleteContent`	`/restapi/v1.0/cms/contents/{contentId}`	DELETE	Elimina el contenido después de comprobar que no está incluido en una lista de reproducción o una programación. Si intenta eliminar contenido incluido en una lista de reproducción o una programación, no se eliminará y se devolverá un código de error.
`getActiveContentInfo`	`/restapi/v1.0/cms/contents/{contentId}`	GET	Cada vez que se modifica el contenido, se actualiza su versión. Se obtiene la versión activa de los detalles del contenido.
`approveContents`	`/restapi/v1.0/cms/contents/{contentId}/approval`	PUT	Aprueba/rechaza el contenido. El contenido aprobado se mueve a la lista de contenido general y se puede utilizar en listas de reproducción o programaciones.
`uploadContent`	`/restapi/v1.0/cms/contents/{groupId}`	POST	Carga contenido nuevo.
`listDefaultGroup`	`/restapi/v1.0/cms/contents/groups`	GET	Importa una lista de grupos de contenido predeterminados.
`getGroup`	`/restapi/v1.0/cms/contents/groups/{groupId}`	GET	Obtiene detalles del grupo `{groupId}`.
`listChildGroup`	`/restapi/v1.0/cms/contents/groups/{groupId}/child`	GET	Importa una lista de subgrupos contenidos en el grupo `{groupId}`.

Lista de reproducción

Utilice el contenido para crear, editar o borrar listas de reproducción. Los usuarios autenticados con privilegios para leer, escribir y gestionar contenido pueden acceder a los servicios relacionados con las listas de reproducción.

Los servicios de gestión de listas de reproducción disponibles son los siguientes:

Nombre del servicio	Llamada de API	Tipo de llamada	Descripción
`listAllPlaylist`	`/restapi/v1.0/cms/playlists`	GET	Importa una lista de todas listas de reproducción. En la lista se incluyen los nombres de las listas de reproducción, las miniaturas de contenido principal, los tipos de listas de reproducción y otra información básica. Las listas se pueden importar por página mediante la información de paginación.
`createPlaylist`	`/restapi/v1.0/cms/playlists`	POST	Crea una nueva lista de reproducción.
`getDashboardPlaylistInfo`	`/restapi/v1.0/cms/playlists/dashboard`	GET	Importa la información de lista de reproducción necesaria del panel.
`listPlaylist`	`/restapi/v1.0/cms/playlists/filter`	POST	Importa una lista de listas de reproducción filtradas de acuerdo con condiciones. Las listas se pueden importar por página mediante la información de paginación.
`deletePlaylist`	`/restapi/v1.0/cms/playlists/{playlistId}`	DELETE	Elimina la lista de reproducción seleccionada. Si intenta eliminar una lista de reproducción incluida en una programación, no se eliminará y se devolverá un código de error.
`getActivePlaylistInfo`	`/restapi/v1.0/cms/playlists/{playlistId}`	GET	Importa detalles sobre una versión activada de una lista de reproducción. La versión de una lista de reproducción se actualiza cada vez que se edita la lista de reproducción.
`editPlaylist`	`/restapi/v1.0/cms/playlists/{playlistId}`	PUT	Modifica la lista de reproducción `{playlistId}`. La edición de una lista de reproducción provoca la actualización de la versión de la lista de reproducción y hace que el dispositivo de reproducción reproduzca automáticamente la lista de reproducción actualizada.
`copyPlaylist`	`/restapi/v1.0/cms/playlists/{playlistId}/copy`	PUT	Copia la lista de reproducción `{playlistId}`. Se crea una copia duplicada de la lista de reproducción.
`listDefaultGroup`	`/restapi/v1.0/cms/playlists/groups`	GET	Importa una lista de los grupos predeterminados de la lista de reproducción.
`getGroup`	`/restapi/v1.0/cms/playlists/groups/{groupId}`	GET	Obtiene detalles del grupo `{groupId}`.
`listChildGroup`	`/restapi/v1.0/cms/playlists/groups/{groupId}/child`	GET	Importa una lista de subgrupos contenidos en el grupo `{groupId}`.

Programación

Cree nuevas programaciones de contenido o mensajes. Publique programaciones en dispositivos para su reproducción. Edite o elimine programaciones.

Los usuarios autenticados con privilegios para leer, escribir y gestionar programaciones pueden acceder a los servicios relacionados con las programaciones.

Los servicios de gestión de programaciones disponibles son los siguientes:

Nombre del servicio	Llamada de API	Tipo de llamada	Descripción
`listContentScheduleAll`	`/restapi/v1.0/dms/schedule/contents`	GET	Importa una lista de todas las programaciones de contenido. En la lista se incluyen los nombres de las programaciones, las fechas de creación, los tipos de dispositivos y otra información básica. Las listas se pueden importar por página mediante la información de paginación.
`createContentSchedule`	`/restapi/v1.0/dms/schedule/contents`	POST	Crea una nueva programación de contenido. Una programación de contenido puede contener varios canales y marcos. Publique una programación en los dispositivos y reproduzca el contenido deseado o una lista de reproducción en un momento especificado.
`listDashboardScheduleInfo`	`/restapi/v1.0/dms/schedule/contents/dashboard`	GET	Importa información de programación de contenido necesaria del panel.
`listContentScheduleByGroup`	`/restapi/v1.0/dms/schedule/contents/filter`	POST	Importa una lista de programaciones de contenido filtrada de acuerdo con diferentes condiciones. Las listas se pueden importar por página mediante la información de paginación.
`deleteContentSchedule`	`/restapi/v1.0/dms/schedule/contents/{programId}`	DELETE	Elimina una programación de contenido. Si elimina una programación previamente publicada en un dispositivo, el dispositivo reproduce automáticamente el contenido predeterminado.
`getProgramInfo`	`/restapi/v1.0/dms/schedule/contents/{programId}`	GET	Importa detalles sobre la programación seleccionada.
`editContentSchedule`	`/restapi/v1.0/dms/schedule/contents/{programId}`	PUT	Edita una programación de contenido. Si edita una programación publicada previamente en un dispositivo, el dispositivo reproduce automáticamente la programación editada.
`copyContentSchedule`	`/restapi/v1.0/dms/schedule/contents/{programId}/copy`	PUT	Copia la programación de contenido `{programId}`. La programación de contenido como `{programId}` se ha creado recientemente.
`deployContentSchedule`	`/restapi/v1.0/dms/schedule/contents/{programId}/deploy`	PUT	Publica una programación de contenido en un grupo de dispositivos específico.
`getPublishStatus`	`/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus`	GET	Importa el estado de descarga de la programación de contenido en tiempo real desde un dispositivo.
`getRootGroups`	`/restapi/v1.0/dms/schedule/contents/groups`	GET	Importa una lista de grupos raíz para una programación de contenido.
`listContentScheduleGroupInfo`	`/restapi/v1.0/dms/schedule/contents/groups/{groupId}`	GET	Obtiene detalles del grupo `{groupId}`.
`listAllMessageSchedule`	`/restapi/v1.0/dms/schedule/messages`	GET	Importa una lista de todas las programaciones de mensajes.
`createMessageSchedule`	`/restapi/v1.0/dms/schedule/messages`	POST	Crea una nueva programación de mensajes.
`listMessage`	`/restapi/v1.0/dms/schedule/messages/filter`	POST	Importa una lista de programaciones de mensajes filtrada según diferentes condiciones. Las listas se pueden importar por página mediante la información de paginación.
`deleteMessageSchedule`	`/restapi/v1.0/dms/schedule/messages/{messageId}`	DELETE	Borra la programación de mensajes seleccionada. Si elimina una programación de mensajes anteriormente publicada en un dispositivo, el cambio se aplica automáticamente al dispositivo.
`getMessageInfo`	`/restapi/v1.0/dms/schedule/messages/{messageId}`	GET	Importa detalles sobre la programación de mensajes seleccionada.
`editMessageSchedule`	`/restapi/v1.0/dms/schedule/messages/{messageId}`	PUT	Modifica la programación de mensajes seleccionada. Si edita una programación de mensajes publicada previamente en un dispositivo, el cambio se aplica automáticamente al dispositivo.
`copyMessageSchedule`	`/restapi/v1.0/dms/schedule/messages/{messageId}/copy`	PUT	Copia la programación de mensajes seleccionada. Se crea una copia duplicada de la programación de mensajes.
`deployMessageSchedule`	`/restapi/v1.0/dms/schedule/messages/{messageId}/deploy`	PUT	Publica la programación de mensajes seleccionada en un grupo de dispositivos.
`getRootGroups`	`/restapi/v1.0/dms/schedule/messages/groups`	GET	Importa una lista de grupos raíz para una programación de contenido.
`listMessageScheduleGroupInfo`	`/restapi/v1.0/dms/schedule/messages/groups/{groupId}`	GET	Obtiene detalles del grupo `{groupId}`.
`getChildGroups`	`/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child`	GET	Importa una lista de subgrupos incluidos en un grupo específico.

Dispositivo

Controle y gestione los dispositivos. Los usuarios autenticados con privilegios para leer, escribir y gestionar dispositivos pueden acceder a los servicios relacionados con los dispositivos.

Los servicios de gestión de dispositivos disponibles son los siguientes:

Nombre del servicio	Llamada de API	Tipo de llamada	Descripción
`listAllDevice`	`/restapi/v1.0/rms/devices`	GET	Importa una lista de todos los dispositivos. En la lista se incluyen el estado de alimentación del dispositivo, la información sobre las miniaturas, el estado de error de dispositivo y otra información básica. Las listas se pueden importar por página mediante la información de paginación.
`getDashboardDeviceInfo`	`/restapi/v1.0/rms/devices/dashboard`	GET	Importa la información de dispositivo necesaria del panel.
`filterDeviceList`	`/restapi/v1.0/rms/devices/filter`	POST	Importa una lista de dispositivos filtrada según diferentes condiciones. Las listas se pueden importar por página mediante la información de paginación.
`deleteDevice`	`/restapi/v1.0/rms/devices/{deviceId}`	DELETE	Borra el dispositivo seleccionado.
`getDevice`	`/restapi/v1.0/rms/devices/{deviceId}`	GET	Importa detalles sobre el dispositivo seleccionado.
`approveDevice`	`/restapi/v1.0/rms/devices/{deviceId}/approval`	PUT	Aprueba el dispositivo seleccionado en un grupo específico.
`getCabinetList`	`/restapi/v1.0/rms/devices/{deviceId}/cabinet`	POST	Importa información sobre las vitrinas conectadas a un dispositivo LED. La información importada solo es válida cuando las vitrinas están conectadas a un dispositivo LED.
`updateCabinetInfo`	`/restapi/v1.0/rms/devices/{deviceId}/cabinet`	PUT	Edita la información sobre las vitrinas conectadas a un dispositivo LED.
`getDisplayControlInfo`	`/restapi/v1.0/rms/devices/{deviceId}/display`	GET	Importa información sobre el control de visualización de dispositivos de la base de datos. Si no hay información de control, se debe enviar una solicitud de información al dispositivo.
`updateDisplayInfo`	`/restapi/v1.0/rms/devices/{deviceId}/display`	PUT	Envía la información sobre el control de visualización editada a un dispositivo. Se envían solo los valores editados de la información de visualización como un protocolo al dispositivo.
`getUpdatedDisplayInfoResult`	`/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}`	GET	Recibe la información sobre el control de visualización editada de un dispositivo. Esta API se ejecuta después de ejecutar la API `updateDisplayInfo`.
`getGeneralInfo`	`/restapi/v1.0/rms/devices/{deviceId}/general`	GET	Importa información general del dispositivo desde la base de datos. La información general del dispositivo se actualiza cuando el dispositivo se conecta al servidor.
`updateGeneralInfo`	`/restapi/v1.0/rms/devices/{deviceId}/general/info`	PUT	Envía la información de dispositivo editada a un dispositivo. Se envían solo los valores editados de la información de dispositivo básica a modo de protocolo al dispositivo.
`getUpdatedGeneralInfoResult`	`/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}`	GET	Recibe la información del dispositivo editada desde un dispositivo. Esta API se ejecuta después de ejecutar la API `updateGeneralInfo`.
`moveDevice`	`/restapi/v1.0/rms/devices/{deviceId}/move`	PUT	Mueve un dispositivo a otro grupo.
`startRmServerVnc`	`/restapi/v1.0/rms/devices/{deviceId}/rmserver/start`	GET	Envía un protocolo de inicio de gestión remota a un dispositivo. Un dispositivo que recibe un protocolo de inicio de gestión remota envía información periódicamente a través del servidor de gestión remota.
`stopRmServerVnc`	`/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop`	GET	Envía un protocolo de detención de gestión remota a un dispositivo. Un dispositivo que recibe un protocolo de detención detiene inmediatamente la función correspondiente.
`getSetupInfo`	`/restapi/v1.0/rms/devices/{deviceId}/setup`	GET	Importa la configuración del dispositivo. La configuración del dispositivo se actualiza cuando el dispositivo se conecta al servidor.
`updateSetupInfo`	`/restapi/v1.0/rms/devices/{deviceId}/setup`	PUT	Envía la configuración de dispositivo editada a un dispositivo. Se envían solo los valores editados de la configuración a modo de protocolo al dispositivo.
`getUpdatedSetupInfoResult`	`/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}`	GET	Recibe la configuración de dispositivo editada de un dispositivo. Esta API se ejecuta después de ejecutar la API `updateSetupInfo`.
`getCurrentStatusDisplay`	`/restapi/v1.0/rms/devices/{deviceId}/status/display`	GET	Envía una solicitud de información de control de visualización actual a un dispositivo. Si se llama a esta API, se devuelve `requestId` como el valor `response`.
`getCurrentStatusDisplay`	`/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}`	GET	Importa la información de control de dispositivo enviada desde un dispositivo. Esta opción se utiliza para dos acciones: enviar una solicitud de información a un dispositivo y recibir la información real del dispositivo.
`getCurrentStatusTime`	`/restapi/v1.0/rms/devices/{deviceId}/status/time`	GET	Envía una solicitud de información de la hora actual a un dispositivo. Si se llama a esta API, se devuelve `requestId` como el valor `response`.
`getCurrentStatusTime`	`/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}`	GET	Importa la información temporal enviada desde un dispositivo. El `requestId` recibido al llamar a `getCurrentStatusTime` debe enviarse como parámetro.
`getTimeInfo`	`/restapi/v1.0/rms/devices/{deviceId}/time`	GET	Importa la información temporal de dispositivo de la base de datos. Si no hay información de control, se debe enviar una solicitud de información al dispositivo.
`updateTimeInfo`	`/restapi/v1.0/rms/devices/{deviceId}/time`	PUT	Envía la información temporal editada a un dispositivo. Se envían solo los valores editados de la información temporal a modo de protocolo al dispositivo.
`getUpdatedTimeInfoResult`	`/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}`	GET	Recibe la información temporal editada desde un dispositivo. Esta API se ejecuta después de ejecutar la API `getUpdatedTimeInfoResult`.
`listDeviceGroupOrgan`	`/restapi/v1.0/rms/devices/groups`	GET	Importa una lista de organizaciones.
`listDeviceGroupInfo`	`/restapi/v1.0/rms/devices/groups/{groupId}`	GET	Obtiene detalles del grupo `{groupId}`.
`listDeviceGroupChild`	`/restapi/v1.0/rms/devices/groups/{groupId}/child`	GET	Busca subgrupos en `{groupId}`.

Usu.

Agregue usuarios y gestione la información de usuario. Los usuarios autenticados con privilegios para leer, escribir y gestionar información de usuario pueden acceder a los servicios relacionados con los usuarios.

Los servicios de gestión de usuarios disponibles son los siguientes:

Nombre del servicio	Llamada de API	Tipo de llamada	Descripción
`createUser`	`/restapi/v1.0/ums/users`	POST	Añade un usuario.
`listDashboardUserInfo`	`/restapi/v1.0/ums/users/dashboard`	GET	Importa la información de usuario necesaria desde el panel.
`updateMyInfo`	`/restapi/v1.0/ums/users/me`	PUT	Edita la información de usuario.
`listUserOrgan`	`/restapi/v1.0/ums/users/organization`	GET	Importa una lista de organizaciones. Esta opción se puede utilizar para configurar un árbol de grupos.
`listUserGroupOrgan`	`/restapi/v1.0/ums/users/groups`	GET	Importa una lista de organizaciones.
`listUserGroupInfo`	`/restapi/v1.0/ums/users/groups/{groupId}`	GET	Obtiene detalles del grupo `{groupId}`.
`listUserGroupChild`	`/restapi/v1.0/ums/users/groups/{groupId}/child`	GET	Importa una lista de subgrupos contenidos en el grupo `{groupId}`.

Configuración

Además de las funciones principales, puede utilizar muchas otras funciones para crear y gestionar etiquetas y categorías, así como editar el panel.

Nombre del servicio	Llamada de API	Tipo de llamada	Descripción
`getCategoryInfo`	`/restapi/v1.0/ems/category/{categoryId}`	GET	Importa una lista de categorías.
`deleteDashboard`	`/restapi/v1.0/ems/dashboard`	DELETE	Elimina la información de un panel específico.
`listDashboardInfo`	`/restapi/v1.0/ems/dashboard`	GET	Importa el contenido que se mostrará en el panel personalizado. Es posible visualizar solo información específica en el panel.
`updateDashboardPriority`	`/restapi/v1.0/ems/dashboard`	PUT	Cambia el orden de los elementos que se muestran en el panel.
`createDashboard`	`/restapi/v1.0/ems/dashboard/create`	GET	Activa un panel inactivo.
`listDashboardLoginInfo`	`/restapi/v1.0/ems/dashboard/login`	GET	Importa la información de inicio de sesión que aparecerá en el panel.
`listDashboardNoticeInfo`	`/restapi/v1.0/ems/dashboard/notice`	GET	Importa la información del tablón de anuncios que se mostrará en el panel.
`deleteNoticeInfo`	`/restapi/v1.0/ems/dashboard/notice/edit`	DELETE	Elimina una publicación del tablón de anuncios.
`listEditNoticeInfo`	`/restapi/v1.0/ems/dashboard/notice/edit`	GET	Importa los detalles de la publicación seleccionada.
`createNoticeInfo`	`/restapi/v1.0/ems/dashboard/notice/edit`	POST	Agrega publicaciones al tablón de anuncios.
`updateNoticeInfo`	`/restapi/v1.0/ems/dashboard/notice/edit`	PUT	Edita la publicación seleccionada en el tablón de anuncios.
`listDashboardStorageInfo`	`/restapi/v1.0/ems/dashboard/storage`	GET	Importa la información de almacenamiento que se mostrará en el panel.
`listLicense`	`/restapi/v1.0/ems/license`	GET	Importa una lista de las licencias registradas en el servidor.
`getServerSetupInfo`	`/restapi/v1.0/ems/setup`	GET	Importa la configuración del servidor. Los elementos de configuración del servidor incluyen opciones que permiten activar o desactivar diferentes funciones en el servidor.
`getTagListInfo`	`/restapi/v1.0/ems/tag`	POST	Importa una lista de etiquetas registradas en el servidor.

Detalles de Open API (interfaz de usuario de Swagger)

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

Content

Space Tools

Versions Compared

Old Version 15

New Version 16

Key

Autenticazione

OPEN API (v2.0)

Contenuto

Playlist

Programma

Dispositivo

Utente

Impostazioni

Dettagli Open API (swagger UI)

Autenticación

OPEN API (v2.0)

Contenido

Lista de reproducción

Programación

Dispositivo

Usu.

Configuración

Detalles de Open API (interfaz de usuario de Swagger)