Premium Server allows you to implement content management, schedule management, device management, and other functions by calling Open API (v2.0).
To use Open API (v2.0), you will first need to go through an authentication process. Use a separate swagger page to test each API.
Authentication
When calling all Open API (v2.0) items, api_token must be included in the header. If this is not included, a "401 Unauthorized" error will be returned.
An obtained token expires and becomes unavailable for use after a specified period of time. If this is the case, you should obtain a new token.
api_token can be obtained by calling the following api.
| Service Name | API call | Call Type | Description |
|---|---|---|---|
| authenticationRequest | /auth | POST | Imports a token value for authentication using the user ID and password. |
| authenticationRequest | /auth/refresh | GET | Creates a new token to extend the expire time. It is possible to call REST API without logging in again |
OPEN API (v2.0)
Premium Server Open API (v2.0) provides a variety of functions. Configuration of each function is shown below.
| Category | Controller | Description |
|---|---|---|
| Content | content-controller | Content file management |
| content-group-controller | Content group management | |
| Playlist | playlist-controller | Managing Playlists |
| playlist-group-controller | Playlist group management | |
| Schedule | content-schedule-controller | Content schedule management |
| content-schedule-group-controller | Content schedule group management | |
| message-schedule-controller | Managing Message Schedules | |
| message-schedule-group-controller | Message schedule group management | |
| Device | device-controller | Device management |
| device-group-controller | Device group management | |
| User | user-controller | User management |
| user-group-controller | User group management | |
| Setting | environment-controller | Setting |
Content
Upload, approve, or delete content. Manage content lists. Content-related services are accessible to authenticated users with privileges to read, write, and manage content.
Available content management services are as follows:
| Service Name | API call | Call Type | Description |
|---|---|---|---|
| listAllContent | /restapi/v1.0/cms/contents | GET | Imports a list of uploaded content. Content thumbnails, names, file types, and other basic information are included in the list. Lists can be imported per page, using paging information. |
| listDashboardContentInfo | /restapi/v1.0/cms/contents/dashboard | GET | Imports general content information to be displayed on the dashboard. |
| listContent | /restapi/v1.0/cms/contents/filter | POST | Imports a list of content filtered based on conditions. Lists can be imported per page, using paging information. |
| forceDeleteContent | /restapi/v1.0/cms/contents/force/{contentId} | DELETE | Deletes content, whether or not the content is included in a playlist or schedule. |
| deleteContent | /restapi/v1.0/cms/contents/{contentId} | DELETE | Deletes content after checking that the content is not included in a playlist or schedule. If attempting to delete content included in a playlist or schedule, the content will not be deleted and an error code will be returned. |
| getActiveContentInfo | /restapi/v1.0/cms/contents/{contentId} | GET | Imports details of an activated version of content. The version of content is updated each time the content is edited. |
| approveContents | /restapi/v1.0/cms/contents/{contentId}/approval | PUT | Approves/rejects content. Approved content is moved to the general content list and can be used in playlists or schedules. |
| uploadContent | /restapi/v1.0/cms/contents/{groupId} | POST | Uploads new content. |
listDefaultGroup | /restapi/v1.0/cms/contents/groups | GET | Imports a list of default content groups. |
| getGroup | /restapi/v1.0/cms/contents/groups/{groupId} | GET | Imports details of the {groupId} group. |
| listChildGroup | /restapi/v1.0/cms/contents/groups/{groupId}/child | GET | Imports a list of sub-groups under the {groupId} group. |
Playlist
Use content to create, edit, or delete playlists. Playlist-related services are accessible to authenticated users with privileges to read, write, and manage content.
Available playlist management services are as follows:
| Service Name | API call | Call Type | Description |
|---|---|---|---|
| listAllPlaylist | /restapi/v1.0/cms/playlists | GET | Imports a list of all playlists. Playlist names, main content thumbnails, playlist types, and other basic information are included in the list. Lists can be imported per page, using paging information. |
| createPlaylist | /restapi/v1.0/cms/playlists | POST | Creates a new playlist. |
getDashboardPlaylistInfo | /restapi/v1.0/cms/playlists/dashboard | GET | Imports necessary playlist information from the dashboard. |
listPlaylist | /restapi/v1.0/cms/playlists/filter | POST | Imports a list of playlists filtered based on conditions. Lists can be imported per page, using paging information. |
deletePlaylist | /restapi/v1.0/cms/playlists/{playlistId} | DELETE | Deletes the selected playlist. If attempting to delete a playlist included in a schedule, the playlist will not be deleted and an error code will be returned. |
getActivePlaylistInfo | /restapi/v1.0/cms/playlists/{playlistId} | GET | Imports details of an activated version of a playlist. The version of a playlist is updated each time the playlist is edited. |
editPlaylist | /restapi/v1.0/cms/playlists/{playlistId} | PUT | Edits the {playlistId} playlist. Editing a playlist updates the playlist version, and causes the device playing the playlist to automatically play the updated playlist. |
copyPlaylist | /restapi/v1.0/cms/playlists/{playlistId}/copy | PUT | Copies the {playlistId} playlist. A duplicate copy of the playlist is created. |
| listDefaultGroup | /restapi/v1.0/cms/playlists/groups | GET | Imports a list of default playlist groups. |
getGroup | /restapi/v1.0/cms/playlists/groups/{groupId} | GET | Imports details of the {groupId} group. |
| listChildGroup | /restapi/v1.0/cms/playlists/groups/{groupId}/child | GET | Imports a list of sub-groups under the {groupId} group. |
Schedule
Create new content or message schedules. Publish schedules to devices for playback. Edit or delete schedules.
Schedule-related services are accessible to authenticated users with privileges to read, write, and manage schedules.
Available schedule management services are as follows:
| Service Name | API call | Call Type | Description |
|---|---|---|---|
| listContentScheduleAll | /restapi/v1.0/dms/schedule/contents | GET | Imports a list of all content schedules. Content schedule names, dates of creation, device types, and other basic information are included in the list. Lists can be imported per page, using paging information. |
| createContentSchedule | /restapi/v1.0/dms/schedule/contents | POST | Creates a new content schedule. A content schedule may contain multiple channels and frames. Publish a schedule to devices and play the desired content or playlist at a specified time. |
| listDashboardScheduleInfo | /restapi/v1.0/dms/schedule/contents/dashboard | GET | Imports necessary content schedule information from the dashboard. |
| listContentScheduleByGroup | /restapi/v1.0/dms/schedule/contents/filter | POST | Imports a list of content schedules filtered based on different conditions. Lists can be imported per page, using paging information. |
| deleteContentSchedule | /restapi/v1.0/dms/schedule/contents/{programId} | DELETE | Deletes a content schedule. If deleting a schedule previously published to a device, the device automatically plays the default content. |
| getProgramInfo | /restapi/v1.0/dms/schedule/contents/{programId} | GET | Imports details of the selected schedule. |
| editContentSchedule | /restapi/v1.0/dms/schedule/contents/{programId} | PUT | Edits a content schedule. If editing a schedule previously published to a device, the device automatically plays the edited schedule. |
| copyContentSchedule | /restapi/v1.0/dms/schedule/contents/{programId}/copy | PUT | Copies the {programId} content schedule. A duplicate copy of the {programId} content schedule is created. |
| deployContentSchedule | /restapi/v1.0/dms/schedule/contents/{programId}/deploy | PUT | Publishes a content schedule to a specific device group. |
| getPublishStatus | /restapi/v1.0/dms/schedule/contents/{programId}/publishStatus | GET | Imports real-time content schedule download status from a device. |
| getRootGroups | /restapi/v1.0/dms/schedule/contents/groups | GET | Imports a list of root groups for a content schedule. |
| listContentScheduleGroupInfo | /restapi/v1.0/dms/schedule/contents/groups/{groupId} | GET | Imports details of the {groupId} group. |
| listAllMessageSchedule | /restapi/v1.0/dms/schedule/messages | GET | Imports a list of all message schedules. |
| createMessageSchedule | /restapi/v1.0/dms/schedule/messages | POST | Creates a new message schedule. |
| listMessage | /restapi/v1.0/dms/schedule/messages/filter | POST | Imports a list of message schedules filtered based on different conditions. Lists can be imported per page, using paging information. |
| deleteMessageSchedule | /restapi/v1.0/dms/schedule/messages/{messageId} | DELETE | Deletes the selected message schedule. If deleting a message schedule previously published to a device, the change is automatically applied to the device. |
| getMessageInfo | /restapi/v1.0/dms/schedule/messages/{messageId} | GET | Imports details of the selected message schedule. |
| editMessageSchedule | /restapi/v1.0/dms/schedule/messages/{messageId} | PUT | Edits the selected message schedule. If editing a message schedule previously published to a device, the change is automatically applied to the device. |
| copyMessageSchedule | /restapi/v1.0/dms/schedule/messages/{messageId}/copy | PUT | Copies the selected message schedule. A duplicate copy of the message schedule is created. |
| deployMessageSchedule | /restapi/v1.0/dms/schedule/messages/{messageId}/deploy | PUT | Publishes the selected message schedule to a device group. |
| getRootGroups | /restapi/v1.0/dms/schedule/messages/groups | GET | Imports a list of root groups for a content schedule. |
| listMessageScheduleGroupInfo | /restapi/v1.0/dms/schedule/messages/groups/{groupId} | GET | Imports details of the {groupId} group. |
| getChildGroups | /restapi/v1.0/dms/schedule/messages/groups/{groupId}/child | GET | Imports a list of sub-groups under a specific group. |
Device
Control and manage devices. Device-related services are accessible to authenticated users with privileges to read, write, and manage devices.
Available device management services are as follows:
| Service Name | API call | Call Type | Description |
|---|---|---|---|
| listAllDevice | /restapi/v1.0/rms/devices | GET | Imports a list of all devices. Device power status, thumbnail info, device error status, and other basic information are included in the list. Lists can be imported per page, using paging information. |
| getDashboardDeviceInfo | /restapi/v1.0/rms/devices/dashboard | GET | Imports necessary device information from the dashboard. |
| filterDeviceList | /restapi/v1.0/rms/devices/filter | POST | Imports a list of devices filtered based on different conditions. Lists can be imported per page, using paging information. |
| deleteDevice | /restapi/v1.0/rms/devices/{deviceId} | DELETE | Deletes the selected device. |
| getDevice | /restapi/v1.0/rms/devices/{deviceId} | GET | Imports details of the selected device. |
| approveDevice | /restapi/v1.0/rms/devices/{deviceId}/approval | PUT | Approves the selected device to a specific group. |
| getCabinetList | /restapi/v1.0/rms/devices/{deviceId}/cabinet | POST | Imports information about cabinets connected to an LED device. The imported information is valid only when the cabinets are connected to an LED device. |
| updateCabinetInfo | /restapi/v1.0/rms/devices/{deviceId}/cabinet | PUT | Edits information about cabinets connected to an LED device. |
| getDisplayControlInfo | /restapi/v1.0/rms/devices/{deviceId}/display | GET | Imports device display control information from the database. If control information is not present, an information request should be sent to the device. |
| updateDisplayInfo | /restapi/v1.0/rms/devices/{deviceId}/display | PUT | Sends edited display control information to a device. Only edited values in display information are sent as a protocol to the device. |
| getUpdatedDisplayInfoResult | /restapi/v1.0/rms/devices/{deviceId}/display/{requestId} | GET | Receives edited display control information from a device. This API is executable after updateDisplayInfo API is executed. |
| getGeneralInfo | /restapi/v1.0/rms/devices/{deviceId}/general | GET | Imports general device information from the database. General device information is updated when the device connects to the server. |
| updateGeneralInfo | /restapi/v1.0/rms/devices/{deviceId}/general/info | PUT | Sends edited device information to a device. Only edited values in basic device information are sent as a protocol to the device. |
| getUpdatedGeneralInfoResult | /restapi/v1.0/rms/devices/{deviceId}/general/{requestId} | GET | Receives edited device information from a device. This API is executable after updateGeneralInfo API is executed. |
| moveDevice | /restapi/v1.0/rms/devices/{deviceId}/move | PUT | Moves a device to another group. |
| startRmServerVnc | /restapi/v1.0/rms/devices/{deviceId}/rmserver/start | GET | Sends an RM start protocol to a device. A device that received an RM start protocol sends information periodically via the RM server. |
| stopRmServerVnc | /restapi/v1.0/rms/devices/{deviceId}/rmserver/stop | GET | Sends an RM stop protocol to a device. A device that received a stop protocol stops the corresponding function immediately. |
| getSetupInfo | /restapi/v1.0/rms/devices/{deviceId}/setup | GET | Imports device settings. Device settings are updated when the device connects to the server. |
| updateSetupInfo | /restapi/v1.0/rms/devices/{deviceId}/setup | PUT | Sends edited device settings to a device. Only edited values in settings are sent as a protocol to the device. |
| getUpdatedSetupInfoResult | /restapi/v1.0/rms/devices/{deviceId}/setup/{requestId} | GET | Receives edited device settings from a device. This API is executable after updateSetupInfo API is executed. |
| getCurrentStatusDisplay | /restapi/v1.0/rms/devices/{deviceId}/status/display | GET | Sends a current display control information request to a device. If calling this API, requestId is returned as the response value. |
| getCurrentStatusDisplay | /restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId} | GET | Imports display control information sent from a device. This option is used for two actions: sending a request for information to a device and receiving actual device information. |
| getCurrentStatusTime | /restapi/v1.0/rms/devices/{deviceId}/status/time | GET | Sends a current time information request to a device.If calling this API, requestId is returned as the response value. |
| getCurrentStatusTime | /restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId} | GET | Imports time information sent from a device. This option is used for two actions: sending a request for information to a device and receiving actual device information. |
| getTimeInfo | /restapi/v1.0/rms/devices/{deviceId}/time | GET | Imports device time information from the database. If control information is not present, an information request should be sent to the device. |
| updateTimeInfo | /restapi/v1.0/rms/devices/{deviceId}/time | PUT | Sends edited time information to a device. Only edited values in time information are sent as a protocol to the device. |
| getUpdatedTimeInfoResult | /restapi/v1.0/rms/devices/{deviceId}/time/{requestId} | GET | Receives edited device time information from a device. This API executable after getUpdatedTimeInfoResult API is executed. |
| listDeviceGroupOrgan | /restapi/v1.0/rms/devices/groups | GET | Imports a list of organizations. |
| listDeviceGroupInfo | /restapi/v1.0/rms/devices/groups/{groupId} | GET | Imports details of the {groupId} group. |
| listDeviceGroupChild | /restapi/v1.0/rms/devices/groups/{groupId}/child | GET | Imports information about sub-groups under {groupId}. |
User
Add users and manage user information. User-related services are accessible to authenticated users with privileges to read, write, and manage user information.
Available user management services are as follows:
| Service Name | API call | Call Type | Description |
|---|---|---|---|
| createUser | /restapi/v1.0/ums/users | POST | Adds a user. |
| listDashboardUserInfo | /restapi/v1.0/ums/users/dashboard | GET | Imports necessary user information from the dashboard. |
| updateMyInfo | /restapi/v1.0/ums/users/me | PUT | Edits user information. |
| listUserOrgan | /restapi/v1.0/ums/users/organization | GET | Imports a list of organizations. This option can be used to configure a group tree. |
| listUserGroupOrgan | /restapi/v1.0/ums/users/groups | GET | Imports a list of organizations. |
| listUserGroupInfo | /restapi/v1.0/ums/users/groups/{groupId} | GET | Imports details of the {groupId} group. |
| listUserGroupChild | /restapi/v1.0/ums/users/groups/{groupId}/child | GET | Imports a list of sub-groups under the {groupId} group. |
Setting
In addition to main functions, you can use many other functions to create and manage tags and categories, and edit the dashboard.
| Service Name | API call | Call Type | Description |
|---|---|---|---|
| getCategoryInfo | /restapi/v1.0/ems/category/{categoryId} | GET | Imports a list of categories. |
| deleteDashboard | /restapi/v1.0/ems/dashboard | DELETE | Deletes specific dashboard information. |
| listDashboardInfo | /restapi/v1.0/ems/dashboard | GET | Imports content to be displayed on the customized dashboard. It is possible to display only specific information on the dashboard. |
| updateDashboardPriority | /restapi/v1.0/ems/dashboard | PUT | Changes the order of items displayed on the dashboard. |
| createDashboard | /restapi/v1.0/ems/dashboard/create | GET | Activates an idle dashboard. |
listDashboardLoginInfo | /restapi/v1.0/ems/dashboard/login | GET | Imports login information to be displayed on the dashboard. |
| listDashboardNoticeInfo | /restapi/v1.0/ems/dashboard/notice | GET | Imports bulletin board information to be displayed on the dashboard. |
| deleteNoticeInfo | /restapi/v1.0/ems/dashboard/notice/edit | DELETE | Deletes a post from the bulletin board. |
| listEditNoticeInfo | /restapi/v1.0/ems/dashboard/notice/edit | GET | Imports details of the selected post. |
| createNoticeInfo | /restapi/v1.0/ems/dashboard/notice/edit | POST | Adds posts to the bulletin board. |
| updateNoticeInfo | /restapi/v1.0/ems/dashboard/notice/edit | PUT | Edits the selected post on the bulletin board. |
| listDashboardStorageInfo | /restapi/v1.0/ems/dashboard/storage | GET | Imports storage information to be displayed on the dashboard. |
listLicense | /restapi/v1.0/ems/license | GET | Imports a list of licenses registered on the server. |
| getServerSetupInfo | /restapi/v1.0/ems/setup | GET | Imports server settings. Server setting items include options that can turn on or off different functions on the server. |
| getTagListInfo | /restapi/v1.0/ems/tag | POST | Imports a list of tags registered on the server. |
Open API Details (swagger UI)
http://184.169.167.38:7001/MagicInfo/swagger-ui.html