Versions Compared

Old Version 72

changes.mady.by.user user-f347e

Saved on

compared with

New Version 73

changes.mady.by.user user-f347e

Saved on

Key

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

...

Sv translation
languagezh_TW


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

Premium 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方法
urlhttp://184.169.167.38:7001/MagicInfo/v2/api-docs/



...