Page History

Versions Compared

Old Version 62

changes.mady.by.user user-f347e

Saved on Apr 24, 2018

compared with

New Version 63

changes.mady.by.user user-f347e

Saved on Apr 25, 2018

Key

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

...

Sv translation

language	zh_TW

MagicInfo Server 可讓您呼叫 Open API (v2.0)，藉此執行內容管理、排程管理、裝置管理和其他功能。

若要使用 Open API (v2.0)，您首先需要經過驗證程序。使用獨立 Swagger 頁面以測試每個 API。

驗證

呼叫所有 Open API (v2.0) 項目時，標頭中必須納入 api_token。若沒有納入此，就會回傳「401 Unauthorized」(未獲授權) 錯誤。

在指定期限後，取得的權杖會過期並變成無法使用。在此情況下，您應取得新的權杖。

呼叫下列 API 可取得 api_token。

服務名稱	API 呼叫	呼叫類型	描述
authenticationRequest	/auth	發佈	使用使用者 ID 和密碼匯入權杖值以進行驗證。
authenticationRequest	/auth/refresh	取得	建立新權杖以延長到期時間。若沒有再次登入，就無法呼叫其餘 API

OPEN API (v2.0)

MagicInfo Server Open API (v2.0) 提供各種功能。每項功能的設定顯示如下。

類別	控制器	描述
內容	內容-控制器	內容檔案管理
內容	內容-群組-控制器	內容群組管理
播放清單	播放清單-控制器	管理播放清單
播放清單	播放清單-群組-控制器	播放清單群組管理
排程	內容-排程-控制器	內容排程管理
	內容-排程-群組-控制器	內容排程群組管理
	訊息-排程-控制器	訊息排程管理
	訊息-排程-群組-控制器	訊息排程群組管理
裝置	裝置-控制器	裝置管理
裝置	裝置-群組-控制器	裝置群組管理
使用者	使用者-控制器	使用者管理
使用者	使用者-群組-控制器	使用者群組管理
設定	環境-控制器	設定

內容

上傳、核准或刪除內容。管理內容清單。接受驗證的使用者可透過權限存取內容相關服務，以讀取、寫入和管理內容。

可用的內容管理服務如下：

服務名稱	API 呼叫	呼叫類型	描述
listAllContent	/restapi/v1.0/cms/contents	取得	匯入上傳的內容清單。內容縮圖、名稱、檔案類型和其他基本資訊皆包括在清單中。可使用分頁資訊每頁匯入清單。
listDashboardContentInfo	/restapi/v1.0/cms/contents/dashboard	取得	匯入要顯示在儀表板上的一般內容資訊。
listContent	/restapi/v1.0/cms/contents/filter	發佈	匯入根據條件篩選的內容清單。可使用分頁資訊每頁匯入清單。
forceDeleteContent	/restapi/v1.0/cms/contents/force/{contentId}	刪除	刪除內容，無論內容是否納入播放清單或排程中。
deleteContent	/restapi/v1.0/cms/contents/{contentId}	刪除	在確認內容未納入播放清單或排程後刪除內容。若嘗試刪除已納入播放清單或排程的內容，該內容將不會被刪除，並回傳錯誤代碼。
getActiveContentInfo	/restapi/v1.0/cms/contents/{contentId}	取得	匯入已啟動內容版本的詳細資訊。內容版本會在每次編輯內容時更新。
approveContents	/restapi/v1.0/cms/contents/{contentId}/approval	放置	核准/拒絕內容。核准的內容會移到一般內容清單，且能在播放清單或排程中使用。
uploadContent	/restapi/v1.0/cms/contents/{groupId}	發佈	上傳新內容。
listDefaultGroup	/restapi/v1.0/cms/contents/groups	取得	匯入預設內容群組清單。
getGroup	/restapi/v1.0/cms/contents/groups/{groupId}	取得	匯入 {groupId} 群組的詳細資訊。
listChildGroup	/restapi/v1.0/cms/contents/groups/{groupId}/child	取得	匯入 {groupId} 群組之下的子群組清單。

播放清單

使用內容以建立、編輯或刪除播放清單。接受驗證的使用者可透過權限存取播放清單相關服務，以讀取、寫入和管理內容。

可用的播放清單管理服務如下：

服務名稱	API 呼叫	呼叫類型	描述
listAllPlaylist	/restapi/v1.0/cms/playlists	取得	匯入所有播放清單。播放清單名稱、主要內容縮圖、播放清單類型和其他基本資訊皆包括在清單中。可使用分頁資訊每頁匯入清單。
createPlaylist	/restapi/v1.0/cms/playlists	發佈	建立一個新的播放清單。
getDashboardPlaylistInfo	/restapi/v1.0/cms/playlists/dashboard	取得	從儀表板匯入必要的播放清單資訊。
listPlaylist	/restapi/v1.0/cms/playlists/filter	發佈	匯入根據條件篩選的播放清單。可使用分頁資訊每頁匯入清單。
deletePlaylist	/restapi/v1.0/cms/playlists/{playlistId}	刪除	刪除所選播放清單。若嘗試刪除已納入排程的播放清單，該播放清單將不會被刪除，並回傳錯誤代碼。
getActivePlaylistInfo	/restapi/v1.0/cms/playlists/{playlistId}	取得	匯入已啟動播放清單版本的詳細資訊。播放清單版本會在每次編輯播放清單時更新。
editPlaylist	/restapi/v1.0/cms/playlists/{playlistId}	放置	編輯 {playlistId} 播放清單。編輯播放清單會更新播放清單版本，並造成播放播放清單的裝置自動播放更新的播放清單。
copyPlaylist	/restapi/v1.0/cms/playlists/{playlistId}/copy	放置	複製 {playlistId} 播放清單。會建立重複的播放清單副本。
listDefaultGroup	/restapi/v1.0/cms/playlists/groups	取得	匯入預設播放清單群組的清單。
getGroup	/restapi/v1.0/cms/playlists/groups/{groupId}	取得	匯入 {groupId} 群組的詳細資訊。
listChildGroup	/restapi/v1.0/cms/playlists/groups/{groupId}/child	取得	匯入 {groupId} 群組之下的子群組清單。

排程

建立新的內容或訊息排程。將排程發佈到裝置以播放。編輯或刪除排程。

接受驗證的使用者可透過權限存取排程相關服務，以讀取、寫入和管理排程。

可用的排程管理服務如下：

服務名稱	API 呼叫	呼叫類型	描述
listContentScheduleAll	/restapi/v1.0/dms/schedule/contents	取得	匯入所有內容排程清單。內容排程名稱、建立日期、裝置類型和其他基本資訊皆包括在清單中。可使用分頁資訊每頁匯入清單。
createContentSchedule	/restapi/v1.0/dms/schedule/contents	發佈	建立新的內容排程。內容排程可包含多個頻道和畫面。將排程發佈到裝置並在指定時間播放所需內容或播放清單。
listDashboardScheduleInfo	/restapi/v1.0/dms/schedule/contents/dashboard	取得	從儀表板匯入必要的內容排程資訊。
listContentScheduleByGroup	/restapi/v1.0/dms/schedule/contents/filter	發佈	匯入根據不同條件篩選的內容排程清單。可使用分頁資訊每頁匯入清單。
deleteContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	刪除	刪除內容排程。若刪除先前發佈到裝置的排程，則裝置會自動播放預設內容。
getProgramInfo	/restapi/v1.0/dms/schedule/contents/{programId}	取得	匯入所選排程的詳細資訊。
editContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	放置	編輯內容排程。若編輯先前發佈到裝置的排程，則裝置會自動播放編輯的排程。
copyContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/copy	放置	複製 {programId} 內容排程。會建立重複的 {programId} 內容排程副本。
deployContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/deploy	放置	將內容排程發佈到特定裝置群組。
getPublishStatus	/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus	取得	從裝置匯入即時內容排程下載狀態。
getRootGroups	/restapi/v1.0/dms/schedule/contents/groups	取得	匯入內容排程的根群組清單。
listContentScheduleGroupInfo	/restapi/v1.0/dms/schedule/contents/groups/{groupId}	取得	匯入 {groupId} 群組的詳細資訊。
listAllMessageSchedule	/restapi/v1.0/dms/schedule/messages	取得	匯入所有訊息排程清單。
createMessageSchedule	/restapi/v1.0/dms/schedule/messages	發佈	建立新的訊息排程。
listMessage	/restapi/v1.0/dms/schedule/messages/filter	發佈	匯入根據不同條件篩選的訊息排程清單。可使用分頁資訊每頁匯入清單。
deleteMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	刪除	刪除所選訊息排程。若刪除先前發佈到裝置的訊息排程，則該變更會自動套用至裝置。
getMessageInfo	/restapi/v1.0/dms/schedule/messages/{messageId}	取得	匯入所選訊息排程的詳細資訊。
editMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	放置	編輯所選訊息排程。若編輯先前發佈到裝置的訊息排程，則該變更會自動套用至裝置。
copyMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/copy	放置	複製所選訊息排程。會建立重複的訊息排程副本。
deployMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/deploy	放置	將所選訊息排程發佈到裝置群組。
getRootGroups	/restapi/v1.0/dms/schedule/messages/groups	取得	匯入內容排程的根群組清單。
listMessageScheduleGroupInfo	/restapi/v1.0/dms/schedule/messages/groups/{groupId}	取得	匯入 {groupId} 群組的詳細資訊。
getChildGroups	/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child	取得	匯入特定群組之下的子群組清單。

裝置

控制並管理裝置。接受驗證的使用者可透過權限存取裝置相關服務，以讀取、寫入和管理裝置。

可用的裝置管理服務如下：

服務名稱	API 呼叫	呼叫類型	描述
listAllDevice	/restapi/v1.0/rms/devices	取得	匯入所有裝置清單。裝置電源狀態、縮圖資訊、裝置錯誤狀態和其他基本資訊皆包括在清單中。可使用分頁資訊每頁匯入清單。
getDashboardDeviceInfo	/restapi/v1.0/rms/devices/dashboard	取得	從儀表板匯入必要的裝置資訊。
filterDeviceList	/restapi/v1.0/rms/devices/filter	發佈	匯入根據不同條件篩選的裝置清單。可使用分頁資訊每頁匯入清單。
deleteDevice	/restapi/v1.0/rms/devices/{deviceId}	刪除	刪除所選裝置。
getDevice	/restapi/v1.0/rms/devices/{deviceId}	取得	匯入所選裝置的詳細資訊。
approveDevice	/restapi/v1.0/rms/devices/{deviceId}/approval	放置	向特定群組核准所選裝置。
getCabinetList	/restapi/v1.0/rms/devices/{deviceId}/cabinet	發佈	匯入關於連接至 LED 裝置之機櫃的資訊。只有在機櫃已連接至 LED 裝置時，匯入的資訊才有效。
updateCabinetInfo	/restapi/v1.0/rms/devices/{deviceId}/cabinet	放置	編輯關於連接至 LED 裝置之機櫃的資訊。
getDisplayControlInfo	/restapi/v1.0/rms/devices/{deviceId}/display	取得	從資料庫匯入裝置顯示控制資訊。若沒有顯示控制資訊，資訊請求應傳送至裝置。
updateDisplayInfo	/restapi/v1.0/rms/devices/{deviceId}/display	放置	將編輯的顯示控制資訊傳送至裝置。只有顯示資訊中已編輯的值會作為通訊協定傳送至裝置。
getUpdatedDisplayInfoResult	/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}	取得	從裝置接收已編輯的顯示控制資訊。在執行 updateDisplayInfo (更新顯示資訊) API 後，即可執行此 API。
getGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general	取得	從資料庫匯入一般裝置資訊。一般裝置資訊會在裝置連線至伺服器時更新。
updateGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general/info	放置	將編輯的裝置資訊傳送至裝置。只有基本裝置資訊中已編輯的值會作為通訊協定傳送至裝置。
getUpdatedGeneralInfoResult	/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}	取得	從裝置接收已編輯的裝置資訊。在執行 updateGeneralInfo (更新一般資訊) API 後，即可執行此 API。
moveDevice	/restapi/v1.0/rms/devices/{deviceId}/move	放置	將裝置移動至另一個群組。
startRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/start	取得	將 RM 啟動通訊協定傳送至裝置。接收 RM 啟動通訊協定的裝置會透過 RM 伺服器定期傳送資訊。
stopRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop	取得	將 RM 停止通訊協定傳送至裝置。接收停止通訊協定的裝置會立刻停止相應的功能。
getSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	取得	匯入裝置設定。裝置設定會在裝置連線至伺服器時更新。
updateSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	放置	將編輯的裝置設定傳送至裝置。只有設定中已編輯的值會作為通訊協定傳送至裝置。
getUpdatedSetupInfoResult	/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}	取得	從裝置接收已編輯的裝置設定。在執行 updateSetupInfo (更新設定資訊) API 後，即可執行此 API。
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display	取得	將目前的顯示控制資訊請求傳送至裝置。若呼叫此 API，就會回傳請求 ID 作為回應值。
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}	取得	匯入從裝置傳送的顯示控制資訊。此選項用於兩個動作：將資訊請求傳送至裝置並接收實際裝置資訊。
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time	取得	將目前的時間資訊請求傳送至裝置。若呼叫此 API，就會回傳請求 ID 作為回應值。
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}	取得	匯入從裝置傳送的時間資訊。此選項用於兩個動作：將資訊請求傳送至裝置並接收實際裝置資訊。
getTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	取得	從資料庫匯入裝置時間資訊。若沒有顯示控制資訊，資訊請求應傳送至裝置。
updateTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	放置	將編輯的時間資訊傳送至裝置。只有時間資訊中已編輯的值會作為通訊協定傳送至裝置。
getUpdatedTimeInfoResult	/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}	取得	從裝置接收已編輯的裝置時間資訊。在執行 getUpdatedTimeInfoResult (取得已更新的時間資訊結果) API 後，即可執行此 API。
listDeviceGroupOrgan	/restapi/v1.0/rms/devices/groups	取得	匯入組織清單。
listDeviceGroupInfo	/restapi/v1.0/rms/devices/groups/{groupId}	取得	匯入 {groupId} 群組的詳細資訊。
listDeviceGroupChild	/restapi/v1.0/rms/devices/groups/{groupId}/child	取得	匯入 {groupId} 之下的子群組相關資訊。

使用者

新增使用者並管理使用者資訊。接受驗證的使用者可透過權限存取使用者相關服務，以讀取、寫入和管理使用者資訊。

可用的使用者管理服務如下：

服務名稱	API 呼叫	呼叫類型	描述
createUser	/restapi/v1.0/ums/users	發佈	新增使用者。
listDashboardUserInfo	/restapi/v1.0/ums/users/dashboard	取得	從儀表板匯入必要的使用者資訊。
updateMyInfo	/restapi/v1.0/ums/users/me	放置	編輯使用者資訊。
listUserOrgan	/restapi/v1.0/ums/users/organization	取得	匯入組織清單。此選項可用來設定群組樹狀結構。
listUserGroupOrgan	/restapi/v1.0/ums/users/groups	取得	匯入組織清單。
listUserGroupInfo	/restapi/v1.0/ums/users/groups/{groupId}	取得	匯入 {groupId} 群組的詳細資訊。
listUserGroupChild	/restapi/v1.0/ums/users/groups/{groupId}/child	取得	匯入 {groupId} 群組之下的子群組清單。

設定

除了主要功能，您也可以使用許多其他功能，以建立並管理標籤和類別，並編輯儀表板。

服務名稱	API 呼叫	呼叫類型	描述
getCategoryInfo	/restapi/v1.0/ems/category/{categoryId}	取得	匯入類別清單。
deleteDashboard	/restapi/v1.0/ems/dashboard	刪除	刪除特定儀表板資訊。
listDashboardInfo	/restapi/v1.0/ems/dashboard	取得	匯入要顯示在自訂儀表板上的內容。可以在儀表板上只顯示特定資訊。
updateDashboardPriority	/restapi/v1.0/ems/dashboard	放置	變更顯示在儀表板上的項目順序。
createDashboard	/restapi/v1.0/ems/dashboard/create	取得	啟動閒置儀表板。
listDashboardLoginInfo	/restapi/v1.0/ems/dashboard/login	取得	匯入要顯示在儀表板上的登入資訊。
listDashboardNoticeInfo	/restapi/v1.0/ems/dashboard/notice	取得	匯入要顯示在儀表板上的佈告欄資訊。
deleteNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	刪除	從佈告欄刪除發佈內容。
listEditNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	取得	匯入所選發佈內容的詳細資訊。
createNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	發佈	將發佈內容新增至佈告欄。
updateNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	放置	在佈告欄上編輯所選發佈內容。
listDashboardStorageInfo	/restapi/v1.0/ems/dashboard/storage	取得	匯入要顯示在儀表板上的儲存資訊。
listLicense	/restapi/v1.0/ems/license	取得	匯入在伺服器上註冊的授權清單。
getServerSetupInfo	/restapi/v1.0/ems/setup	取得	匯入伺服器設定。伺服器設定項目包括可在伺服器上開啟或關閉不同功能的選項。
getTagListInfo	/restapi/v1.0/ems/tag	發佈	匯入在伺服器上註冊的標籤清單。

Open API 詳細資訊 (swagger UI)

Open API Documentation

docExpansion	無
validatorUrl	無
operationsSorter	方法
url	http://184.169.167.38:7001/MagicInfo/v2/api-docs/

Sv translation

language	es

MagicInfo Server le Premium 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 Premium 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)