Page History

Versions Compared

Old Version 70

changes.mady.by.user user-f347e

Saved on May 14, 2018

compared with

New Version 71

changes.mady.by.user user-dd421

Saved on May 14, 2018

Key

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

...

Sv translation

language	es

MagicINFO Server le permite implementar la gestión de contenidos, la gestión de programaciones, la gestión 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. De lo contrario, se devolverá un error 401 (no autorizado).

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 (versión 2.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	Importa detalles sobre una versión de contenido activada. La versión de contenido se actualiza cada vez que el contenido se edita.
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	Importa detalles sobre el 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	Edita 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	Importa detalles sobre el 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}. Se crea una copia duplicada de la programación de contenido {programId}.
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	Importa detalles sobre el 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	Importa detalles sobre el 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 puede ejecutar después de la ejecución de 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 puede ejecutar después de la ejecución de 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 puede ejecutar después de la ejecución de 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 valor de respuesta.
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 valor de respuesta.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}	GET	Importa la información temporal 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.
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 puede ejecutar después de la ejecución de 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	Importa detalles sobre el grupo {groupId}.
listDeviceGroupChild	/restapi/v1.0/rms/devices/groups/{groupId}/child	GET	Importa la información sobre los subgrupos de {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	Importa detalles sobre el 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)

Open API Documentation

docExpansion	ninguno
validatorUrl	ninguno
operationsSorter	método
url	http://184.169.167.38:7001/MagicInfo/v2/api-docs/

Sv translation

language	pl

MagicInfo Server umożliwia zarządzanie treściami, harmonogramami, urządzeniami, a także udostępnia inne funkcje wywołując Open API (v2.0).

Aby używać Open API (v2.0) należy najpierw przejść proces uwierzytelniania. Do przetestowania każdego API należy użyć strony swagger.

Uwierzytelnianie

Przy wywoływaniu wszystkich pozycji Open API (v2.0) w nagłówku musi znajdować się api_token. Jeżeli się tam nie znajdzie, wyświetli się błąd "401 Nieupoważniony".

Otrzymany token wygasa i nie można go wykorzystać po upływie określonego czasu. W takim przypadku należy uzyskać nowy token.

api_token można uzyskać wywołując następujący api.

Nazwa usługi	Wywoływanie API	Typ wywołania	Opis
authenticationRequest	/auth	POST	Importuje wartość tokena do uwierzytelnienia z wykorzystaniem ID i hasła użytkownika.
authenticationRequest	/auth/refresh	GET	Tworzy nowy token, by przedłużyć moment wygaśnięcia. Istnieje możliwość wywołania REST API bez ponownego logowania się

OPEN API (v2.0)

MagicInfo Server Open API (v2.0) oferuje różnego rodzaju funkcje. Konfiguracja każdej funkcji podana jest poniżej

Kategoria	Kontroler	Opis
Treści	Kontroler treści	Zarządzanie plikami z treściami
Treści	Kontroler grupy treści	Zarządzanie grupą treści
Lista odtwarzania	Kontroler listy odtwarzania	Zarządzanie listami odtwarzania
Lista odtwarzania	Kontroler listy grup odtwarzania	Zarządzanie grupą list odtwarzania
Harmonogram	Kontroler harmonogramu treści	Zarządzanie harmonogramem treści
	Kontroler grupy harmonogramów treści	Zarządzanie grupą harmonogramów treści
	Kontroler harmonogramu wiadomości	Zarządzanie harmonogramami wiadomości
	Kontroler grupy harmonogramów wiadomości	Zarządzanie grupą harmonogramów wiadomości
Urządzenie	Kontroler urządzenia	Zarządzanie urządzeniami
Urządzenie	Kontroler grupy urządzeń	Zarządzanie grupą urządzeń
Użytkownik	Kontroler użytkowników	Zarządzanie użytkownikami
Użytkownik	Kontroler grupy użytkowników	Zarządzanie grupą użytkowników
Ustawienia	Kontroler środowiska	Ustawienia

Treści

Ładowanie, zatwierdzanie lub kasowanie treści. Zarządzanie listami treści. Usługi dotyczące treści są dostępne dla uwierzytelnionych użytkowników upoważnionych do wyświetlania i zapisywania treści oraz do zarządzania nimi.

Dostępne są następujące usługi zarządzania treściami:

Nazwa usługi	Wywoływanie API	Typ wywołania	Opis
listAllContent	/restapi/v1.0/cms/contents	GET	Import listy załadowanych treści. Na liście znajdują się miniaturki, nazwy treści, typy plików i inne podstawowe informacje. Listy można importować z poszczególnych stron, korzystając z danych o stronicowaniu.
listDashboardContentInfo	/restapi/v1.0/cms/contents/dashboard	GET	Import ogólnych informacji o treściach do wyświetlania na pulpicie nawigacyjnym.
listContent	/restapi/v1.0/cms/contents/filter	POST	Import listy treści odfiltrowanych na podstawie warunków. Listy można importować z poszczególnych stron, korzystając z danych o stronicowaniu.
forceDeleteContent	/restapi/v1.0/cms/contents/force/{contentId}	DELETE	Kasowanie treści niezależnie od tego, czy są zawarte na liście odtwarzania lub w harmonogramie, czy nie.
deleteContent	/restapi/v1.0/cms/contents/{contentId}	DELETE	Kasowanie treści po sprawdzeniu, że treści nie zawarte na liście odtwarzania lub w harmonogramie. Przy próbie usunięcia treści zawartych na liście odtwarzania lub w harmonogramie treści te nie zostaną usunięte i wyświetli się kod błędu.
getActiveContentInfo	/restapi/v1.0/cms/contents/{contentId}	GET	Import szczegółów aktywowanej wersji treści. Ta wersja treści jest aktualizowana za każdym razem po edycji treści.
approveContents	/restapi/v1.0/cms/contents/{contentId}/approval	PUT	Zatwierdzenie/odrzucenie treści. Zatwierdzone treści przenoszone są do listy treści ogólnych i można je wykorzystać do list odtwarzania lub harmonogramów.
uploadContent	/restapi/v1.0/cms/contents/{groupId}	POST	Ładuje nowe treści.
listDefaultGroup	/restapi/v1.0/cms/contents/groups	GET	Import listy domyślnych grup treści.
getGroup	/restapi/v1.0/cms/contents/groups/{groupId}	GET	Import szczegółów grupy {groupId}.
listChildGroup	/restapi/v1.0/cms/contents/groups/{groupId}/child	GET	Import listy podgrup grupy {groupId}.

Lista odtwarzania

Używanie treści do tworzenia, edycji lub kasowania list odtwarzania. Usługi dotyczące list odtwarzania są dostępne dla uwierzytelnionych użytkowników upoważnionych do wyświetlania i zapisywania treści oraz do zarządzania nimi.

Dostępne są następujące usługi zarządzania listami odtwarzania:

Nazwa usługi	Wywoływanie API	Typ wywołania	Opis
listAllPlaylist	/restapi/v1.0/cms/playlists	GET	Import listy wszystkich list odtwarzania. Na liście znajdują się nazwy list odtwarzania, miniaturki podstawowych treści, typy list odtwarzania i inne podstawowe informacje. Listy można importować z poszczególnych stron, korzystając z danych o stronicowaniu.
createPlaylist	/restapi/v1.0/cms/playlists	POST	Tworzy nową listę odtwarzania.
getDashboardPlaylistInfo	/restapi/v1.0/cms/playlists/dashboard	GET	Import niezbędnych informacji o liście odtwarzania z pulpitu nawigacyjnego.
listPlaylist	/restapi/v1.0/cms/playlists/filter	POST	Import listy list odtwarzania odfiltrowanych na podstawie warunków. Listy można importować z poszczególnych stron, korzystając z danych o stronicowaniu.
deletePlaylist	/restapi/v1.0/cms/playlists/{playlistId}	DELETE	Usuwanie wybranej listy odtwarzania. Przy próbie skasowania listy odtwarzania zawartej w harmonogramie lista nie zostanie skasowana i wyświetli się kod błędu.
getActivePlaylistInfo	/restapi/v1.0/cms/playlists/{playlistId}	GET	Import szczegółów aktywowanej wersji listy odtwarzania. Ta wersja listy odtwarzania jest aktualizowana za każdym razem po edycji lsty odtwarzania.
editPlaylist	/restapi/v1.0/cms/playlists/{playlistId}	PUT	Edytowanie listy odtwarzania {playlistId}. Edycja listy odtwarzania aktualizuje wersję listy odtwarzania i powoduje automatyczne odtwarzanie zaktualizowanej listy odtwarzania przez urządzenie ją odtwarzające.
copyPlaylist	/restapi/v1.0/cms/playlists/{playlistId}/copy	PUT	Kopiuje listę odtwarzania {playlistId}. Utworzony zostaje duplikat listy odtwarzania.
listDefaultGroup	/restapi/v1.0/cms/playlists/groups	GET	Import listy domyślnych grup list odtwarzania.
getGroup	/restapi/v1.0/cms/playlists/groups/{groupId}	GET	Import szczegółów grupy {groupId}.
listChildGroup	/restapi/v1.0/cms/playlists/groups/{groupId}/child	GET	Import listy podgrup grupy {groupId}.

Harmonogram

Tworzenie nowych harmonogramów treści lub wiadomości. Publikowanie harmonogramów do odtworzenia na urządzeniach. Edytowanie lub kasowanie harmonogramów.

Usługi dotyczące harmonogramów są dostępne dla uwierzytelnionych użytkowników upoważnionych do wyświetlania i zapisywania harmonogramów oraz do zarządzania nimi.

Dostępne są następujące usługi zarządzania harmonogramami:

Nazwa usługi	Wywoływanie API	Typ wywołania	Opis
listContentScheduleAll	/restapi/v1.0/dms/schedule/contents	GET	Import listy wszystkich harmonogramów treści. Na liście znajdują się nazwy harmonogramów treści, daty utworzenia, typy urządzeń i inne podstawowe informacje. Listy można importować z poszczególnych stron, korzystając z danych o stronicowaniu.
createContentSchedule	/restapi/v1.0/dms/schedule/contents	POST	Tworzenie nowego harmonogramu treści. Harmonogram treści może zawierać wiele kanałów i ramek. Publikacja harmonogramu na urządzeniach i odtwarzania żądanych treści lub listy odtwarzania we wskazanym czasie.
listDashboardScheduleInfo	/restapi/v1.0/dms/schedule/contents/dashboard	GET	Import niezbędnych informacji o harmonogramie treści z pulpitu nawigacyjnego.
listContentScheduleByGroup	/restapi/v1.0/dms/schedule/contents/filter	POST	Import listy harmonogramów treści odfiltrowanych na podstawie różnych warunków. Listy można importować z poszczególnych stron, korzystając z danych o stronicowaniu.
deleteContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	DELETE	Usuwanie harmonogramu treści. Przy usuwaniu harmonogramu wcześniej opublikowanego na urządzeniu urządzenie automatycznie odtwarza treści domyślne.
getProgramInfo	/restapi/v1.0/dms/schedule/contents/{programId}	GET	Import szczegółów wybranego harmonogramu.
editContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	PUT	Edytowanie harmonogramu treści. Przy edytowaniu harmonogramu wcześniej opublikowanego na urządzeniu urządzenie automatycznie odtwarza edytowany harmonogram.
copyContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/copy	PUT	Kopiuje harmonogram treści {programId}. Utworzony zostaje duplikat harmonogramu treści {programId}.
deployContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/deploy	PUT	Publikuje harmonogram treści na konkretnej grupie urządzeń.
getPublishStatus	/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus	GET	Import status pobierania harmonogramu treści w czasie rzeczywistym z urządzenia.
getRootGroups	/restapi/v1.0/dms/schedule/contents/groups	GET	Import listy grup głównych dla harmonogramu treści.
listContentScheduleGroupInfo	/restapi/v1.0/dms/schedule/contents/groups/{groupId}	GET	Import szczegółów grupy {groupId}.
listAllMessageSchedule	/restapi/v1.0/dms/schedule/messages	GET	Import listy wszystkich harmonogramów wiadomości.
createMessageSchedule	/restapi/v1.0/dms/schedule/messages	POST	Tworzenie nowego harmonogramu wiadomości.
listMessage	/restapi/v1.0/dms/schedule/messages/filter	POST	Import listy harmonogramów wiadomości odfiltrowanych na podstawie różnych warunków. Listy można importować z poszczególnych stron, korzystając z danych o stronicowaniu.
deleteMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	DELETE	Usuwanie wybranego harmonogramu wiadomości. Przy usuwaniu harmonogramu wiadomości wcześniej opublikowanego na urządzeniu zmiana jest na nim automatycznie wprowadzana.
getMessageInfo	/restapi/v1.0/dms/schedule/messages/{messageId}	GET	Import szczegółów wybranego harmonogramu wiadomości.
editMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	PUT	Edytowanie wybranego harmonogramu wiadomości. Przy edycji harmonogramu wiadomości wcześniej opublikowanego na urządzeniu zmiana jest na nim automatycznie wprowadzana.
copyMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/copy	PUT	Kopiowanie wybranego harmonogramu wiadomości. Utworzony zostaje duplikat harmonogramu wiadomości.
deployMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/deploy	PUT	Publikuje harmonogram wiadomości na konkretnej grupie urządzeń.
getRootGroups	/restapi/v1.0/dms/schedule/messages/groups	GET	Import listy grup głównych dla harmonogramu treści.
listMessageScheduleGroupInfo	/restapi/v1.0/dms/schedule/messages/groups/{groupId}	GET	Import szczegółów grupy {groupId}.
getChildGroups	/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child	GET	Import listy podgrup konkretnej grupy.

Urządzenie

Sterowanie i zarządzanie urządzeniami. Usługi dotyczące urządzeń są dostępne dla uwierzytelnionych użytkowników z prawem do wyświetlania urządzeń, zapisywania na nich oraz do zarządzania nimi.

Dostępne są następujące usługi zarządzania urządzeniami:

Nazwa usługi	Wywoływanie API	Typ wywołania	Opis
listAllDevice	/restapi/v1.0/rms/devices	GET	Import listy wszystkich urządzeń. Na liście znajduje się status zasilania urządzenia, informacje o miniaturkach, statusie błędu urządzenia i inne podstawowe informacje. Listy można importować z poszczególnych stron, korzystając z danych o stronicowaniu.
getDashboardDeviceInfo	/restapi/v1.0/rms/devices/dashboard	GET	Import niezbędnych informacji o urządzeniu z pulpitu nawigacyjnego.
filterDeviceList	/restapi/v1.0/rms/devices/filter	POST	Import listy urządzeń odfiltrowanych na podstawie różnych warunków. Listy można importować z poszczególnych stron, korzystając z danych o stronicowaniu.
deleteDevice	/restapi/v1.0/rms/devices/{deviceId}	DELETE	Usuwa wybrane urządzenie.
getDevice	/restapi/v1.0/rms/devices/{deviceId}	GET	Import szczegółów wybranego urządzenia.
approveDevice	/restapi/v1.0/rms/devices/{deviceId}/approval	PUT	Zatwierdzenie wybranego urządzenia do konkretnej grupy.
getCabinetList	/restapi/v1.0/rms/devices/{deviceId}/cabinet	POST	Importuje informacje dotyczące szaf podłączonych do urządzenia LED. Zaimportowane informacje są ważne jedynie wtedy, gdy szafy są podłączone do urządzenia LED.
updateCabinetInfo	/restapi/v1.0/rms/devices/{deviceId}/cabinet	PUT	Edytuje informacje dotyczące szaf podłączonych do urządzenia LED.
getDisplayControlInfo	/restapi/v1.0/rms/devices/{deviceId}/display	GET	Import z bazy danych informacji dotyczących sterowania urządzeniem z ekranem. Jeżeli informacje o sterowaniu nie występują, do urządzenia powinno zostać wysłane żądanie podania informacji.
updateDisplayInfo	/restapi/v1.0/rms/devices/{deviceId}/display	PUT	Wysyła wyedytowane informacje dotyczące sterowania ekranem do urządzenia. Do urządzenia jako protokół wysyłane są wyłącznie wyedytowane wartości w informacjach o ekranie.
getUpdatedDisplayInfoResult	/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}	GET	Odbiera z urządzenia wyedytowane informacje dotyczące sterowania ekranem. To API jest wykonywane po wykonaniu updateDisplayInfo.
getGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general	GET	Import ogólnych informacji o urządzeniu z bazy danych. Ogólne informacje o urządzeniu są aktualizowane, gdy urządzenie łączy się z serwerem.
updateGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general/info	PUT	Wysyła na urządzenie wyedytowane informacje dotyczące urządzenia. Do urządzenia jako protokół wysyłane są wyłącznie wyedytowane wartości w podstawowych informacjach o urządzeniu.
getUpdatedGeneralInfoResult	/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}	GET	Odbiera z urządzenia wyedytowane informacje dotyczące urządzenia. To API jest wykonywane po wykonaniu updateGeneralInfo.
moveDevice	/restapi/v1.0/rms/devices/{deviceId}/move	PUT	Przenosi urządzenie do innej grupy.
startRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/start	GET	Wysyła protokół startu RM na urządzenie. Urządzenie, które odebrało protokół startu RM wysyła okresowo informacje za pośrednictwem serwera RM.
stopRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop	GET	Wysyła protokół stopu RM na urządzenie. Urządzenie, które odebrało protokół stopu RM niezwłocznie zatrzymuje odpowiednią funkcję RM.
getSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	GET	Import ustawień urządzenia. Ustawienia urządzenia są aktualizowane, gdy urządzenie łączy się z serwerem.
updateSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	PUT	Wysyła na urządzenie wyedytowane ustawienia urządzenia. Do urządzenia jako protokół wysyłane są wyłącznie wyedytowane wartości w ustawieniach.
getUpdatedSetupInfoResult	/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}	GET	Odbiera z urządzenia wyedytowane ustawienia urządzenia. To API jest wykonywane po wykonaniu updateSetupInfo.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display	GET	Wysyła informacje dotyczące bieżącego sterowania ekranem do urządzenia. Przy wywołaniu tego API jako wartość odpowiedzi zwracana jest wartość requestId.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}	GET	Importuje z urządzenia informacje dotyczące sterowania ekranem. Ta opcja służy do wysłania żądania podania informacji na urządzenie i odbierania informacji o urządzeniu.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time	GET	Wysyła do urządzenia żądanie podania informacji o bieżącym czasie. Przy wywołaniu tego API jako wartość odpowiedzi zwracana jest wartość requestId.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}	GET	Importuje informacje o czasie przesłane z urządzenia. Ta opcja służy do: wysłania żądania podania informacji na urządzenie i odbierania informacji o urządzeniu.
getTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	GET	Import z bazy danych informacji o czasie urządzenia. Jeżeli informacje o sterowaniu nie występują, do urządzenia powinno zostać wysłane żądanie podania informacji.
updateTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	PUT	Wysyła na urządzenie wyedytowane informacje o czasie. Do urządzenia jako protokół wysyłane są wyłącznie wyedytowane wartości w informacjach o czasie.
getUpdatedTimeInfoResult	/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}	GET	Odbiera z urządzenia wyedytowane informacje o czasie. To API jest wykonywane po wykonaniu getUpdatedTimeInfoResult API.
listDeviceGroupOrgan	/restapi/v1.0/rms/devices/groups	GET	Import listy organizacji.
listDeviceGroupInfo	/restapi/v1.0/rms/devices/groups/{groupId}	GET	Import szczegółów grupy {groupId}.
listDeviceGroupChild	/restapi/v1.0/rms/devices/groups/{groupId}/child	GET	Import informacji o podgrupach w {groupId}.

Użytkownik

Dodawanie użytkowników i zarządzanie informacjami o nich. Usługi dotyczące użytkowników są dostępne dla uwierzytelnionych użytkowników upoważnionych do wyświetlania, zapisywania i zarządzania danymi użytkowników.

Dostępne są następujące usługi zarządzania użytkownikami:

Nazwa usługi	Wywoływanie API	Typ wywołania	Opis
createUser	/restapi/v1.0/ums/users	POST	Dodawanie użytkownika.
listDashboardUserInfo	/restapi/v1.0/ums/users/dashboard	GET	Import niezbędnych informacji o użytkowniku z pulpitu nawigacyjnego.
updateMyInfo	/restapi/v1.0/ums/users/me	PUT	Edytowanie informacji o użytkowniku.
listUserOrgan	/restapi/v1.0/ums/users/organization	GET	Import listy organizacji. Ta opcja może być użyta do konfiguracji drzewa grupy.
listUserGroupOrgan	/restapi/v1.0/ums/users/groups	GET	Import listy organizacji.
listUserGroupInfo	/restapi/v1.0/ums/users/groups/{groupId}	GET	Import szczegółów grupy {groupId}.
listUserGroupChild	/restapi/v1.0/ums/users/groups/{groupId}/child	GET	Import listy podgrup grupy {groupId}.

Ustawienia

Oprócz głównych funkcji można także używać wielu innych funkcji: do tworzenia znaczników i kategorii oraz zarządzania nimi, a także do edytowania pulpitu nawigacyjnego.

Nazwa usługi	Wywoływanie API	Typ wywołania	Opis
getCategoryInfo	/restapi/v1.0/ems/category/{categoryId}	GET	Import listy kategorii.
deleteDashboard	/restapi/v1.0/ems/dashboard	DELETE	Usuwanie konkretnych informacji z pulpitu nawigacyjnego.
listDashboardInfo	/restapi/v1.0/ems/dashboard	GET	Import treści do wyświetlania na dostosowanym pulpicie nawigacyjnym. Można wyświetlać na pulpicie nawigacyjnym jedynie konkretne informacje.
updateDashboardPriority	/restapi/v1.0/ems/dashboard	PUT	Zmienia porządek elementów wyświetlanych na pulpicie nawigacyjnym.
createDashboard	/restapi/v1.0/ems/dashboard/create	GET	Aktywuje nieaktywny pulpit nawigacyjny.
listDashboardLoginInfo	/restapi/v1.0/ems/dashboard/login	GET	Import informacji o logowaniu do wyświetlania na pulpicie nawigacyjnym.
listDashboardNoticeInfo	/restapi/v1.0/ems/dashboard/notice	GET	Import informacji z tablicy wiadomości do wyświetlania na pulpicie nawigacyjnym.
deleteNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	DELETE	Usuwa post z tablicy wiadomości.
listEditNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	GET	Import szczegółów wybranego postu.
createNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	POST	Dodaje posty do tablicy wiadomości.
updateNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	PUT	Edytuje wybrany post na tablicy wiadomości.
listDashboardStorageInfo	/restapi/v1.0/ems/dashboard/storage	GET	Import informacji o przechowywaniu do wyświetlania na pulpicie nawigacyjnym.
listLicense	/restapi/v1.0/ems/license	GET	Import listy licencji zarejestrowanych na serwerze.
getServerSetupInfo	/restapi/v1.0/ems/setup	GET	Import ustawień serwera. Elementy ustawień serwera obejmują opcje, które mogą włączać lub wyłączać poszczególne funkcje na serwerze.
getTagListInfo	/restapi/v1.0/ems/tag	POST	Import listy tagów zarejestrowanych na serwerze.

Szczegóły API Details (interfejs użytkownika swagger)

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

Content

Space Tools