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

Sv translation

language	zh_CN

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

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

身份验证

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

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

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

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

OPEN API (v2.0)

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

类别	控制器	说明
内容	`content-controller`	内容文件管理
内容	`content-group-controller`	内容组管理
播放列表	`playlist-controller`	管理播放列表
播放列表	`playlist-group-controller`	播放列表组管理
日程表	`content-schedule-controller`	内容日程表管理
	`content-schedule-group-controller`	内容日程表组管理
	`message-schedule-controller`	管理消息日程表
	`message-schedule-group-controller`	消息日程表组管理
设备	`device-controller`	设备管理
设备	`device-group-controller`	设备组管理
用户	`user-controller`	用户管理
用户	`user-group-controller`	用户组管理
设置	`environment-controller`	设置

内容

上传、批准或删除内容。管理内容列表。具有读取、写入和管理内容权限的经验证用户可以访问内容相关服务。

可用的内容管理服务如下：

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

播放列表

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

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

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

日程表

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

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

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

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

设备

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

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

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

用户

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

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

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

设置

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

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

Open API 详情 (swagger UI)

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

Content

Space Tools

Versions Compared

Old Version 16

New Version 17

Key

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)

身份验证

OPEN API (v2.0)

内容

播放列表

日程表

设备

用户

设置

Open API 详情 (swagger UI)