Page History

Versions Compared

Old Version 95

changes.mady.by.user user-f347e

Saved on Aug 03, 2018

compared with

New Version 96

changes.mady.by.user user-f347e

Saved on Aug 03, 2018

Key

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

Comment: Content imported from a Scroll Translations translation file.

Sv translation

language	ko_KR

MagicINFO Server에서는 콘텐츠 관리, 스케줄 관리, 장치 관리 등 각 기능을 Open API (v2.0) 호출을 통하여 구현할 수 있습니다.

Open API (v2.0)를 사용하기 위해서는 먼저 인증 절차를 거쳐야 하며, 별도의 swagger 페이지를 통해 각 API를 테스트 할 수 있습니다.

Authentication

모든 Open API (v2.0) 호출 시 헤더에 api_token을 포함하여야 하며, 그렇지 않은 경우 '401 Unauthorized.' 에러를 받게 됩니다.

발급 받은 토큰은 정해진 일정 시간이 지나면 만료되어 사용이 중지되며, 그 경우 토큰을 새로 발급 받아야 합니다.

api_token은 아래 api 호출을 통해 발급받을 수 있습니다.

Service Name	API call	Call Type	Description
authenticationRequest	/auth	POST	사용자 ID 및 비밀번호를 이용하여 인증을 위한 토큰 값을 가져옵니다.
authenticationRequest	/auth/refresh	GET	토큰을 새로 생성하여 만료시간을 연장합니다. 재 로그인 없이 계속해서 REST API를 호출할 수 있습니다.

OPEN API (v2.0)

매직인포 서버 Open API (v2.0) 는 여러가지 기능을 제공하며 기능별 구성은 아래와 같습니다.

Category	Controller	Description
Content	content-controller	콘텐츠 관리
Content	content-group-controller	콘텐츠 그룹 관리
Playlist	playlist-controller	플레이리스트 관리
Playlist	playlist-group-controller	플레이리스트 그룹 관리
Schedule	content-schedule-controller	콘텐츠 스케줄 관리
	content-schedule-group-controller	콘텐츠 스케줄 그룹 관리
	message-schedule-controller	메시지 스케줄 관리
	message-schedule-group-controller	메시지 스케줄 그룹 관리
Device	device-controller	장치 관리
Device	device-group-controller	장치 그룹 관리
User	user-controller	사용자 관리
User	user-group-controller	사용자 그룹 관리
Setting	environment-controller	환경 설정

Content

콘텐츠 업로드, 승인, 삭제, 리스트 관리 등 콘텐츠를 관리할 수 있습니다. 콘텐츠 관련 서비스는 인증을 받은 사용자가 콘텐츠 읽기/쓰기/관리 권한을 가져야만 접근할 수 있습니다.

콘텐츠를 관리하는 서비스는 아래와 같습니다.

Service Name	API call	Call Type	Description
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} 그룹의 하위 그룹 목록을 가져옵니다.

Playlist

콘텐츠를 이용하여 플레이리스트를 만들고, 수정 및 삭제 등 관리 할 수 있습니다. 플레이리스트 관련 서비스는 인증을 받은 사용자가 콘텐츠 읽기/쓰기/관리 권한을 가져야만 접근할 수 있습니다.

플레이리스트를 관리하는 서비스는 아래와 같습니다.

Service Name	API call	Call Type	Description
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} 그룹의 하위 그룹 목록을 가져옵니다.

Schedule

새 콘텐츠/메시지 스케줄을 만들고, 장치에 배포하여 재생 할 수 있습니다. 또한 스케줄을 수정하거나 삭제 하는 등 관리 할 수 있습니다.

스케줄 관련 서비스는 인증을 받은 사용자가 스케줄 읽기/쓰기/관리 권한을 가져야만 접근할 수 있습니다.

스케줄을 관리하는 서비스는 아래와 같습니다.

Service Name	API call	Call Type	Description
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	원하는 그룹의 하위 그룹 목록을 가져옵니다.

Device

각 장치를 제어하고 관리 할 수있습니다. 장치 관련 서비스는 인증을 받은 사용자가 장치 읽기/쓰기/관리 권한을 가져야만 접근할 수 있습니다.

장치를 관리하는 서비스는 아래와 같습니다.

Service Name	API call	Call Type	Description
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	DB에서 장치의 디스플레이 제어 정보를 가져옵니다. 해당 정보가 존재하지 않는 경우 장치에 정보를 요청하여야 합니다.
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	DB에서 장치의 일반 정보를 가져옵니다. 장치의 일반 정보는 장치가 서버에 연결되는 시점에 업데이트 됩니다.
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 시작 프로토콜을 받은 장치는 RM server를 통해 정보를 주기적으로 전송합니다.
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를 호출하면 response값으로 requestId를 전달받게 됩니다.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}	GET	장치에서 전달받은 디스플레이 제어 정보를 가져옵니다. 장치로 정보를 요청하는 경우와, 장치 정보를 실제로 전달받는 경우 2가지 형태로 사용됩니다.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time	GET	장치에 현재 시간 상태를 요청합니다. 이 API를 호출하면 response값으로 requestId를 전달받게 됩니다.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}	GET	장치에서 전달받은 시간 정보를 가져옵니다. getCurrentStatusTime를 호출하여 받은 requestId를 파라미터로 전달해야 합니다.
getTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	GET	DB에서 장치 시간 정보를 가져옵니다. 해당 정보가 존재하지 않는 경우 장치에 정보를 요청하여야 합니다.
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}에 속한 하위 그룹 정보를 가져옵니다.

User

새 사용자를 추가하고, 사용자의 정보를 관리할 수 있습니다. 사용자 관련 서비스는 인증을 받은 사용자가 사용자 읽기/쓰기/관리 권한을 가져야만 접근할 수 있습니다.

사용자를 관리하는 서비스는 아래와 같습니다.

Service Name	API call	Call Type	Description
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} 그룹에 속한 하위 그룹 목록을 가져옵니다.

Setting

주요 기능 이외에도 태그, 카테고리를 생성, 관리하고 대시보드를 수정하는 등 다양한 기능을 구현할 수 있습니다.

Service Name	API call	Call Type	Description
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	서버 설정 정보를 가져옵니다. 서버 설정에는 서버의 여러가지 기능들을 on/off 할 수 있는 기능을 제공합니다.
getTagListInfo	/restapi/v1.0/ems/tag	POST	서버에 등록된 태그 목록을 가져옵니다.

Open API Details (swagger UI)

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

Sv translation

language	en

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

MagicINFO 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	content-group-controller	Content group management
Playlist	playlist-controller	Managing Playlists
Playlist	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	device-group-controller	Device group management
User	user-controller	User management
User	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

Sv translation

language	it

MagicINFO Server consente di implementare la gestione di contenuti, la gestione di programmazioni, la gestione di dispositivi e altre funzioni chiamando Open API (v2.0).

Prima di poter usare Open API (v2.0) sarà necessario seguire un processo di autenticazione. Usare una pagina Swagger a parte per testare ciascuna API.

Autenticazione

Se si chiamano tutti gli elementi di Open API (v2.0), è necessario includere api_token nell'intestazione. Se non lo si include, restituirà un errore “401 Unauthorized”.

I token ottenuti scadono e diventano indisponibili per l'uso dopo un determinato periodo di tempo. In tal caso, sarà necessario ottenere un nuovo token.

È possibile ottenere api_token chiamando la seguente api.

Nome servizio assistenza	Chiamata API	Tipo di chiamata	Descrizione
authenticationRequest	/auth	POST	Importa il valore di un token per l'autenticazione usando l'ID utente e la password.
authenticationRequest	/auth/refresh	GET	Crea un nuovo token per ampliare il tempo di scadenza. È possibile chiamare REST API senza effettuare nuovamente l'accesso

OPEN API (v2.0)

MagicINFO Server Open API (v2.0) fornisce una varietà di funzioni. Di seguito si mostra la configurazione di ciascuna funzione.

Categoria	Controller	Descrizione
Contenuto	contenuto-controller	Gestione contenuti
Contenuto	contenuto-gruppo-controller	Gestione del gruppo di contenuti
Playlist	playlist-controller	Gestione di una playlist
Playlist	playlist-gruppo-controller	Gestione del gruppo di playlist
Programma	contenuto-programmazione-controller	Gestione programmazione di contenuti
	contenuto-programmazione-gruppo-controller	Gestione del gruppo di programmazioni di contenuti
	messaggio-programmazione-controller	Gestione dei programmi messaggio
	messaggio-programmazione-gruppo-controller	Gestione del gruppo di programmazioni di messaggi
Dispositivo	dispositivo-controller	Gestione dispositivo
Dispositivo	dispositivo-gruppo-controller	Gestione del gruppo di dispositivi
Utente	utente-controller	Gestione utente
Utente	utente-gruppo-controller	Gestione gruppo utente
Impostazioni	ambiente-controller	Impostazioni

Contenuto

Caricare, approvare o eliminare contenuto. Gestire elenchi di contenuti. Sono accessibili servizi relazionati con i contenuti per gli utenti autenticati con privilegi di lettura, scrittura e gestione di contenuti.

I servizi di gestione dei contenuti disponibili sono:

Nome servizio assistenza	Chiamata API	Tipo di chiamata	Descrizione
listAllContent	/restapi/v1.0/cms/contents	GET	Importa un elenco di contenuto aggiornato. Si includono nell'elenco anteprime di contenuti, nomi, tipi di file e altre informazioni di base. Gli elenchi possono essere importati per pagina, usando le informazioni di paging.
listDashboardContentInfo	/restapi/v1.0/cms/contents/dashboard	GET	Importa le informazioni dei contenuti generali da visualizzare sulla dashboard.
listContent	/restapi/v1.0/cms/contents/filter	POST	Importa un elenco di contenuti filtrato in base alle condizioni. Gli elenchi possono essere importati per pagina, usando le informazioni di paging.
forceDeleteContent	/restapi/v1.0/cms/contents/force/{contentId}	DELETE	Elimina contenuto, a prescindere dal fatto che sia incluso in una playlist o in una programmazione.
deleteContent	/restapi/v1.0/cms/contents/{contentId}	DELETE	Elimina contenuto dopo aver verificato che non è incluso in una playlist o in una programmazione. Se si cerca di eliminare del contenuto incluso in una playlist o in una programmazione, il contenuto non sarà eliminato e si restituirà un codice di errore.
getActiveContentInfo	/restapi/v1.0/cms/contents/{contentId}	GET	Importa dettagli di una versione attivata del contenuto. La versione del contenuto si aggiorna ogni volta che si modifica il contenuto.
approveContents	/restapi/v1.0/cms/contents/{contentId}/approval	PUT	Approva/respinge il contenuto. Il contenuto approvato viene spostato nell'elenco del contenuto generale e può essere usato in playlist e programmazioni.
uploadContent	/restapi/v1.0/cms/contents/{groupId}	POST	Esegue l'upload di contenuto nuovo.
listDefaultGroup	/restapi/v1.0/cms/contents/groups	GET	Importa un elenco di gruppi di contenuti predefiniti.
getGroup	/restapi/v1.0/cms/contents/groups/{groupId}	GET	Importa dettagli del gruppo {groupId}.
listChildGroup	/restapi/v1.0/cms/contents/groups/{groupId}/child	GET	Importa un elenco di sottogruppi nel gruppo {groupId}.

Playlist

Usare contenuto per creare, modificare o eliminare playlist. Sono accessibili servizi relazionati con le playlist per gli utenti autenticati con privilegi di lettura, scrittura e gestione di contenuti.

I servizi di gestione delle playlist disponibili sono:

Nome servizio assistenza	Chiamata API	Tipo di chiamata	Descrizione
listAllPlaylist	/restapi/v1.0/cms/playlists	GET	Importa un elenco di tutte le playlist. Si includono nell'elenco nomi di playlist, anteprime di contenuti principali, tipi di playlist e altre informazioni di base. Gli elenchi possono essere importati per pagina, usando le informazioni di paging.
createPlaylist	/restapi/v1.0/cms/playlists	POST	Crea una nuova playlist.
getDashboardPlaylistInfo	/restapi/v1.0/cms/playlists/dashboard	GET	Importa informazioni necessarie sulla playlist dalla dashboard.
listPlaylist	/restapi/v1.0/cms/playlists/filter	POST	Importa un elenco di playlist filtrato in base alle condizioni. Gli elenchi possono essere importati per pagina, usando le informazioni di paging.
deletePlaylist	/restapi/v1.0/cms/playlists/{playlistId}	DELETE	Elimina la playlist selezionata. Se si cerca di eliminare una playlist inclusa in una programmazione, la playlist non sarà eliminata e si restituirà un codice di errore.
getActivePlaylistInfo	/restapi/v1.0/cms/playlists/{playlistId}	GET	Importa dettagli di una versione attivata di una playlist. La versione di una playlist si aggiorna ogni volta che si modifica la playlist stessa.
editPlaylist	/restapi/v1.0/cms/playlists/{playlistId}	PUT	Modifica la playlist {playlistId}. Se si modifica una playlist si aggiorna la versione della playlist e, di conseguenza, il dispositivo che riproduce la playlist riproduce automaticamente la playlist aggiornata.
copyPlaylist	/restapi/v1.0/cms/playlists/{playlistId}/copy	PUT	Copia la playlist {playlistId}. Si crea una copia duplicata della playlist.
listDefaultGroup	/restapi/v1.0/cms/playlists/groups	GET	Importa un elenco di gruppi di playlist predefinite.
getGroup	/restapi/v1.0/cms/playlists/groups/{groupId}	GET	Importa dettagli del gruppo {groupId}.
listChildGroup	/restapi/v1.0/cms/playlists/groups/{groupId}/child	GET	Importa un elenco di sottogruppi nel gruppo {groupId}.

Programma

Creare nuove programmazioni di contenuto o messaggi. Pubblicare programmazioni sui dispositivi per la riproduzione. Modificare o eliminare programmazioni.

Sono accessibili servizi relazionati con le programmazioni per gli utenti autenticati con privilegi di lettura, scrittura e gestione di programmazioni.

I servizi di gestione delle programmazioni disponibili sono:

Nome servizio assistenza	Chiamata API	Tipo di chiamata	Descrizione
listContentScheduleAll	/restapi/v1.0/dms/schedule/contents	GET	Importa un elenco di tutte le programmazioni di contenuti. Si includono nell'elenco nomi di programmazioni di contenuti, date di creazione, tipi di dispositivi e altre informazioni di base. Gli elenchi possono essere importati per pagina, usando le informazioni di paging.
createContentSchedule	/restapi/v1.0/dms/schedule/contents	POST	Crea una nuova programmazione di contenuti. Una programmazione di contenuti può contenere vari canali e cornici. Pubblicare una programmazione sui dispositivi e riprodurre il contenuto desiderato o la playlist ad un'ora specificata.
listDashboardScheduleInfo	/restapi/v1.0/dms/schedule/contents/dashboard	GET	Importa informazioni necessarie sulla programmazione di contenuti dalla dashboard.
listContentScheduleByGroup	/restapi/v1.0/dms/schedule/contents/filter	POST	Importa un elenco di programmazioni di contenuti filtrato in base alle differenti condizioni. Gli elenchi possono essere importati per pagina, usando le informazioni di paging.
deleteContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	DELETE	Elimina una programmazione di contenuti. Se si elimina una programmazione precedentemente pubblicata su un dispositivo, il dispositivo riproduce automaticamente il contenuto predefinito.
getProgramInfo	/restapi/v1.0/dms/schedule/contents/{programId}	GET	Importa dettagli della programmazione selezionata.
editContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	PUT	Modifica una programmazione di contenuti. Se si modifica una programmazione precedentemente pubblicata su un dispositivo, il dispositivo riproduce automaticamente la programmazione modificata.
copyContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/copy	PUT	Copia la programmazione di contenuti {programId}. Si crea una copia duplicata della programmazione di contenuti {programId}.
deployContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/deploy	PUT	Pubblica una programmazione di contenuti su un gruppo specifico di dispositivi.
getPublishStatus	/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus	GET	Importa lo stato di download in tempo reale di una programmazione di contenuti dal dispositivo.
getRootGroups	/restapi/v1.0/dms/schedule/contents/groups	GET	Importa un elenco di gruppi principali per una programmazione di contenuti.
listContentScheduleGroupInfo	/restapi/v1.0/dms/schedule/contents/groups/{groupId}	GET	Importa dettagli del gruppo {groupId}.
listAllMessageSchedule	/restapi/v1.0/dms/schedule/messages	GET	Importa un elenco di tutte le programmazioni di messaggi.
createMessageSchedule	/restapi/v1.0/dms/schedule/messages	POST	Crea una nuova programmazione di messaggi.
listMessage	/restapi/v1.0/dms/schedule/messages/filter	POST	Importa un elenco di programmazioni di messaggi filtrato in base alle differenti condizioni. Gli elenchi possono essere importati per pagina, usando le informazioni di paging.
deleteMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	DELETE	Elimina la programmazione di messaggi selezionata. Se si elimina una programmazione di messaggi precedentemente pubblicata su un dispositivo, il cambio si applica automaticamente al dispositivo.
getMessageInfo	/restapi/v1.0/dms/schedule/messages/{messageId}	GET	Importa dettagli della programmazione di messaggi selezionata.
editMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	PUT	Modifica la programmazione di messaggi selezionata. Se si modifica una programmazione di messaggi precedentemente pubblicata su un dispositivo, il cambio si applica automaticamente al dispositivo.
copyMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/copy	PUT	Copia la programmazione di messaggi selezionata. Si crea una copia duplicata della programmazione di messaggi.
deployMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/deploy	PUT	Pubblica la programmazione di messaggi selezionata su un gruppo di dispositivi.
getRootGroups	/restapi/v1.0/dms/schedule/messages/groups	GET	Importa un elenco di gruppi principali per una programmazione di contenuti.
listMessageScheduleGroupInfo	/restapi/v1.0/dms/schedule/messages/groups/{groupId}	GET	Importa dettagli del gruppo {groupId}.
getChildGroups	/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child	GET	Importa un elenco di sottogruppi in un gruppo specifico.

Dispositivo

Controllare e gestire dispositivi. Sono accessibili servizi relazionati con i dispositivi per gli utenti autenticati con privilegi di lettura, scrittura e gestione di dispositivi.

I servizi di gestione dei dispositivi disponibili sono:

Nome servizio assistenza	Chiamata API	Tipo di chiamata	Descrizione
listAllDevice	/restapi/v1.0/rms/devices	GET	Importa un elenco di tutti i dispositivi. Si includono nell'elenco lo stato di alimentazione del dispositivo, info di anteprima, stato dell'errore del dispositivo e altre informazioni di base. Gli elenchi possono essere importati per pagina, usando le informazioni di paging.
getDashboardDeviceInfo	/restapi/v1.0/rms/devices/dashboard	GET	Importa informazioni necessarie sul dispositivo dalla dashboard.
filterDeviceList	/restapi/v1.0/rms/devices/filter	POST	Importa un elenco di dispositivi filtrato in base alle differenti condizioni. Gli elenchi possono essere importati per pagina, usando le informazioni di paging.
deleteDevice	/restapi/v1.0/rms/devices/{deviceId}	DELETE	Elimina il dispositivo selezionato.
getDevice	/restapi/v1.0/rms/devices/{deviceId}	GET	Importa dettagli del dispositivo selezionato.
approveDevice	/restapi/v1.0/rms/devices/{deviceId}/approval	PUT	Approva il dispositivo selezionato su un gruppo specifico.
getCabinetList	/restapi/v1.0/rms/devices/{deviceId}/cabinet	POST	Importa informazioni sui case collegati a un dispositivo LED. Le informazioni importate sono valide solo fino a quando il case è collegato a un dispositivo LED.
updateCabinetInfo	/restapi/v1.0/rms/devices/{deviceId}/cabinet	PUT	Modifica informazioni sui case collegati a un dispositivo LED.
getDisplayControlInfo	/restapi/v1.0/rms/devices/{deviceId}/display	GET	Importa informazioni sul controllo della visualizzazione di un dispositivo dal database. Se non sono presenti informazioni sul controllo, si dovrà inviare al dispositivo una richiesta di informazioni.
updateDisplayInfo	/restapi/v1.0/rms/devices/{deviceId}/display	PUT	Invia informazioni modificate sul controllo della visualizzazione a un dispositivo. Si inviano al dispositivo sotto forma di protocollo solo i valori modificati delle informazioni di visualizzazione.
getUpdatedDisplayInfoResult	/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}	GET	Riceve informazioni modificate sul controllo della visualizzazione da un dispositivo. Questa API è eseguibili dopo aver eseguito l'API updateDisplayInfo.
getGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general	GET	Importa informazioni generali sul dispositivo dal database. Le informazioni generali sul dispositivo vengono aggiornate quando si collega il dispositivo al server.
updateGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general/info	PUT	Invia informazioni modificate sul dispositivo a un dispositivo. Si inviano al dispositivo sotto forma di protocollo solo i valori modificati delle informazioni di base del dispositivo.
getUpdatedGeneralInfoResult	/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}	GET	Riceve informazioni modificate sul dispositivo da un dispositivo. Questa API è eseguibili dopo aver eseguito l'API updateGeneralInfo.
moveDevice	/restapi/v1.0/rms/devices/{deviceId}/move	PUT	Sposta un dispositivo su un altro gruppo.
startRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/start	GET	Invia un protocollo di avvio RM a un dispositivo. Il dispositivo che riceve il protocollo di avvio RM invia quindi periodicamente informazioni mediante il server RM.
stopRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop	GET	Invia un protocollo di interruzione RM a un dispositivo. Il dispositivo che riceve il protocollo interruzione interrompe immediatamente la funzione corrispondente.
getSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	GET	Importa le impostazioni del dispositivo. Le impostazioni del dispositivo vengono aggiornate quando si collega il dispositivo al server.
updateSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	PUT	Invia impostazioni modificate del dispositivo a un dispositivo. Si inviano al dispositivo sotto forma di protocollo solo i valori modificati delle impostazioni.
getUpdatedSetupInfoResult	/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}	GET	Riceve impostazioni modificate del dispositivo da un dispositivo. Questa API è eseguibili dopo aver eseguito l'API updateSetupInfo.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display	GET	Invia una richiesta di informazioni sul controllo della visualizzazione attuale a un dispositivo. Se si chiama questa API, si restituisce requestId come valore di risposta.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}	GET	Importa informazioni sul controllo della visualizzazione inviate da un dispositivo. Questa opzione è usata per due azioni: inviare una richiesta di informazioni a un dispositivo e ricevere informazioni sul dispositivo reale.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time	GET	Invia una richiesta di informazioni sull'orario attuale a un dispositivo. Se si chiama questa API, si restituisce requestId come valore di risposta.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}	GET	Importa informazioni sull'orario inviate da un dispositivo. Questa opzione è usata per due azioni: inviare una richiesta di informazioni a un dispositivo e ricevere informazioni sul dispositivo reale.
getTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	GET	Importa informazioni sull'orario di un dispositivo dal database. Se non sono presenti informazioni sul controllo, si dovrà inviare al dispositivo una richiesta di informazioni.
updateTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	PUT	Invia informazioni modificate sull'orario a un dispositivo. Si inviano al dispositivo sotto forma di protocollo solo i valori modificati delle informazioni sull'orario.
getUpdatedTimeInfoResult	/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}	GET	Riceve informazioni modificate sull'orario del dispositivo da un dispositivo. Questa API è eseguibili dopo aver eseguito l'API getUpdatedTimeInfoResult.
listDeviceGroupOrgan	/restapi/v1.0/rms/devices/groups	GET	Importa un elenco di organizzazioni.
listDeviceGroupInfo	/restapi/v1.0/rms/devices/groups/{groupId}	GET	Importa dettagli del gruppo {groupId}.
listDeviceGroupChild	/restapi/v1.0/rms/devices/groups/{groupId}/child	GET	Importa informazioni sui sottogruppi di {groupId}.

Utente

Aggiungere utenti e gestire le informazioni utente. Sono accessibili servizi relazionati con gli utenti per gli utenti autenticati con privilegi di lettura, scrittura e gestione di informazioni utente.

I servizi di gestione degli utenti disponibili sono:

Nome servizio assistenza	Chiamata API	Tipo di chiamata	Descrizione
createUser	/restapi/v1.0/ums/users	POST	Aggiunge un utente.
listDashboardUserInfo	/restapi/v1.0/ums/users/dashboard	GET	Importa informazioni necessarie sull'utente dalla dashboard.
updateMyInfo	/restapi/v1.0/ums/users/me	PUT	Modifica le informazioni utente.
listUserOrgan	/restapi/v1.0/ums/users/organization	GET	Importa un elenco di organizzazioni. È possibile usare questa opzione per configurare un albero dei gruppi.
listUserGroupOrgan	/restapi/v1.0/ums/users/groups	GET	Importa un elenco di organizzazioni.
listUserGroupInfo	/restapi/v1.0/ums/users/groups/{groupId}	GET	Importa dettagli del gruppo {groupId}.
listUserGroupChild	/restapi/v1.0/ums/users/groups/{groupId}/child	GET	Importa un elenco di sottogruppi nel gruppo {groupId}.

Impostazioni

Oltre alle funzioni principali, è possibile usare molte altre funzioni per creare e gestire tag e categorie e modificare la dashboard.

Nome servizio assistenza	Chiamata API	Tipo di chiamata	Descrizione
getCategoryInfo	/restapi/v1.0/ems/category/{categoryId}	GET	Importa un elenco di categorie.
deleteDashboard	/restapi/v1.0/ems/dashboard	DELETE	Elimina specifiche informazioni della dashboard.
listDashboardInfo	/restapi/v1.0/ems/dashboard	GET	Importa contenuti da visualizzare sulla dashboard personalizzata. È possibile visualizzare solo informazioni specifiche sulla dashboard.
updateDashboardPriority	/restapi/v1.0/ems/dashboard	PUT	Cambia l'ordine degli elementi visualizzati sulla dashboard.
createDashboard	/restapi/v1.0/ems/dashboard/create	GET	Attiva una dashboard inattiva.
listDashboardLoginInfo	/restapi/v1.0/ems/dashboard/login	GET	Importa le informazioni di accesso da visualizzare sulla dashboard.
listDashboardNoticeInfo	/restapi/v1.0/ems/dashboard/notice	GET	Importa le informazioni della bacheca da visualizzare sulla dashboard.
deleteNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	DELETE	Elimina una pubblicazione dalla bacheca.
listEditNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	GET	Importa dettagli della pubblicazione selezionata.
createNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	POST	Aggiunge pubblicazioni alla bacheca.
updateNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	PUT	Modifica la pubblicazione selezionata sulla bacheca.
listDashboardStorageInfo	/restapi/v1.0/ems/dashboard/storage	GET	Importa le informazioni di archiviazione da visualizzare sulla dashboard.
listLicense	/restapi/v1.0/ems/license	GET	Importa un elenco di licenze registrate sul server.
getServerSetupInfo	/restapi/v1.0/ems/setup	GET	Importa le impostazioni del server. Gli elementi di impostazione del server includono opzioni che possono attivare o disattivare funzioni diverse sul server.
getTagListInfo	/restapi/v1.0/ems/tag	POST	Importa un elenco di tag registrati sul server.

Dettagli Open API (swagger UI)

Open API Documentation

docExpansion	nessuno
validatorUrl	nessuno
operationsSorter	metodo
url	http://184.169.167.38:7001/MagicInfo/v2/api-docs/

Sv translation

language	de

MagicINFO Server ermöglicht es Ihnen, Content Management, Terminmanagement, Gerätemanagement und andere Funktionen zu implementieren, indem Sie Open API (v2.0) aufrufen.

Für die Verwendung von Open API (v2.0) müssen Sie zuerst einen Authentifizierungsprozess durchlaufen. Verwenden Sie eine separate Swagger-Seite, um jedes einzelne API zu testen.

Authentifizierung

Beim Aufrufen aller Open API (v2.0)-Elemente muss api_token im Header enthalten sein. Wenn dies nicht enthalten ist, wird ein „401 Unauthorized“-Fehler zurückgegeben.

Ein erhaltener Token läuft nach einem bestimmten Zeitraum ab und wird nicht mehr verfügbar. In diesem Fall sollten Sie einen neuen Token erhalten.

api_token können durch Aufrufen der folgenden Api abgerufen werden.

Name des Dienstes	API-Aufruf	Ereignistyp	Beschreibung
authenticationRequest	/auth	POST	Importiert einen Token-Wert für die Authentifizierung unter Verwendung der Benutzer-ID und des Kennworts.
authenticationRequest	/auth/refresh	GET	Erstellt ein neues Token, um die Ablaufzeit zu verlängern. Es ist möglich, REST API aufzurufen, ohne sich erneut anzumelden

OPEN API (v2.0)

MagicINFO Server Open API (v2.0) bietet eine Vielzahl von Funktionen. Die Konfiguration der einzelnen Funktionen wird unten dargestellt.

Kategorie	Controller	Beschreibung
Inhalt	Inhalte-Controller	Content Management
Inhalt	Inhalte-Gruppe-Controller	Inhaltsgruppen-Verwaltung
Wiedergabeliste	Wiedergabeliste-Controller	Verwalten einer Wiedergabeliste
Wiedergabeliste	Wiedergabeliste-Gruppe-Controller	Wiedergabelistengruppen-Verwaltung
Zeitplan	Inhalte-Zeitplan-Controller	Inhaltszeitplan-Verwaltung
	Inhalte-Zeitplan-Gruppe-Controller	Inhaltszeitplan-Gruppenverwaltung
	Nachricht-Zeitplan-Controller	Verwalten von Nachrichtenzeitplänen
	Nachricht-Zeitplan-Gruppe-Controller	Nachrichten-Zeitplan-Gruppenverwaltung
Gerät	Gerät-Controller	Gerätemanagement
Gerät	Gerät-Gruppe-Controller	Gerätegruppen-Verwaltung
Benutzer	Benutzer-Controller	Benutzerverwaltung
Benutzer	Benutzer-Gruppe-Controller	Benutzergruppen-Verwaltung
Einstellung	Umgebung-Controller	Einstellung

Inhalt

Hochladen, Genehmigen oder Löschen von Inhalten. Verwalten von Inhaltsdateizeitplänen Inhaltsbezogene Dienste sind für authentifizierte Benutzer mit Berechtigungen zum Lesen, Schreiben und Verwalten von Inhalten zugänglich.

Die folgenden Inhaltsverwaltungsdienste sind verfügbar:

Name des Dienstes	API-Aufruf	Ereignistyp	Beschreibung
listAllContent	/restapi/v1.0/cms/contents	GET	Importiert eine Liste mit hochgeladenen Inhalten. In der Liste sind Inhalts-Miniaturen, Namen, Dateitypen und andere grundlegende Informationen enthalten. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.
listDashboardContentInfo	/restapi/v1.0/cms/contents/dashboard	GET	Importiert allgemeine Inhaltsinformationen, die auf dem Dashboard angezeigt werden.
listContent	/restapi/v1.0/cms/contents/filter	POST	Importiert eine Liste mit anhand der Bedingungen gefilterten Inhalten. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.
forceDeleteContent	/restapi/v1.0/cms/contents/force/{contentId}	DELETE	Löscht Inhalte, unabhängig davon, ob die Inhalte in einer Wiedergabeliste oder einem Zeitplan enthalten sind.
deleteContent	/restapi/v1.0/cms/contents/{contentId}	DELETE	Löscht Inhalte, nachdem überprüft wurde, dass die Inhalte nicht in einer Wiedergabeliste oder einem Zeitplan enthalten sind. Wenn Sie versuchen, Inhalte zu löschen, die in einer Wiedergabeliste oder einem Zeitplan enthalten sind, werden die Inhalte nicht gelöscht und es wird ein Fehlercode zurückgegeben.
getActiveContentInfo	/restapi/v1.0/cms/contents/{contentId}	GET	Importiert Details einer aktivierten Version von Inhalten. Die Version der Inhalte wird jedes Mal aktualisiert, wenn die Wiedergabeliste bearbeitet wird.
approveContents	/restapi/v1.0/cms/contents/{contentId}/approval	PUT	Genehmigt Inhalte/lehnt Inhalte ab. Genehmigte Inhalte werden in die allgemeine Inhaltsliste bewegt und können in Wiedergabelisten oder Zeitplänen verwendet werden.
uploadContent	/restapi/v1.0/cms/contents/{groupId}	POST	Lädt neue Inhalte hoch.
listDefaultGroup	/restapi/v1.0/cms/contents/groups	GET	Importiert eine Liste der Standard-Inhaltsgruppen.
getGroup	/restapi/v1.0/cms/contents/groups/{groupId}	GET	Importiert Details der {groupId}-Gruppe.
listChildGroup	/restapi/v1.0/cms/contents/groups/{groupId}/child	GET	Importiert eine Liste der Untergruppen unter der {groupId}-Gruppe.

Wiedergabeliste

Verwenden Sie Inhalte zum Erstellen, Bearbeiten oder Löschen von Wiedergabelisten. Wiedergabelistenbezogene Dienste sind für authentifizierte Benutzer mit Berechtigungen zum Lesen, Schreiben und Verwalten von Inhalten zugänglich.

Die folgenden Wiedergabelistenverwaltungsdienste sind verfügbar:

Name des Dienstes	API-Aufruf	Ereignistyp	Beschreibung
listAllPlaylist	/restapi/v1.0/cms/playlists	GET	Importiert eine Liste mit allen Wiedergabelisten. In der Liste sind Namen von Wiedergabelisten, Miniaturen von Hauptinhalten, Typen von Wiedergabelisten und andere grundlegende Informationen enthalten. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.
createPlaylist	/restapi/v1.0/cms/playlists	POST	Erstellt eine neue Wiedergabeliste.
getDashboardPlaylistInfo	/restapi/v1.0/cms/playlists/dashboard	GET	Importiert notwendige Wiedergabelisteninformationen vom Dashboard.
listPlaylist	/restapi/v1.0/cms/playlists/filter	POST	Importiert eine Liste mit anhand der Bedingungen gefilterten Wiedergabelisten. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.
deletePlaylist	/restapi/v1.0/cms/playlists/{playlistId}	DELETE	Löscht die ausgewählte Wiedergabeliste. Wenn Sie versuchen, eine Wiedergabeliste zu löschen, die in einem Zeitplan enthalten ist, wird die Wiedergabeliste nicht gelöscht und es wird ein Fehlercode zurückgegeben.
getActivePlaylistInfo	/restapi/v1.0/cms/playlists/{playlistId}	GET	Importiert Details einer aktivierten Version einer Wiedergabeliste. Die Version einer Wiedergabeliste wird jedes Mal aktualisiert, wenn die Wiedergabeliste bearbeitet wird.
editPlaylist	/restapi/v1.0/cms/playlists/{playlistId}	PUT	Bearbeitet die {playlistId}-Wiedergabeliste. Das Bearbeiten einer Wiedergabeliste aktualisiert die Wiedergabelistenversion und bewirkt, dass das Gerät, das die Wiedergabeliste abspielt, die aktualisierte Wiedergabeliste automatisch abspielt.
copyPlaylist	/restapi/v1.0/cms/playlists/{playlistId}/copy	PUT	Kopiert die {playlistId} Wiedergabeliste. Ein Duplikat der Wiedergabeliste wurde erstellt.
listDefaultGroup	/restapi/v1.0/cms/playlists/groups	GET	Importiert eine Liste der Standard-Wiedergabelistengruppen.
getGroup	/restapi/v1.0/cms/playlists/groups/{groupId}	GET	Importiert Details der {groupId}-Gruppe.
listChildGroup	/restapi/v1.0/cms/playlists/groups/{groupId}/child	GET	Importiert eine Liste der Untergruppen unter der {groupId}-Gruppe.

Zeitplan

Neue Inhalte oder Nachrichtenzeitpläne erstellen. Zeitpläne an Geräte für die Wiedergabe übermitteln. Zeitpläne löschen oder bearbeiten.

Den Zeitplan betreffende Dienste sind für authentifizierte Benutzer mit Berechtigungen zum Lesen, Schreiben und Verwalten von Zeitplänen zugänglich.

Die folgenden Zeitplanverwaltungsdienste sind verfügbar:

Name des Dienstes	API-Aufruf	Ereignistyp	Beschreibung
listContentScheduleAll	/restapi/v1.0/dms/schedule/contents	GET	Importiert eine Liste aller Inhaltszeitpläne. In der Liste sind Namen von Inhaltszeitplänen, Erstellungsdaten und andere grundlegenden Informationen enthalten. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.
createContentSchedule	/restapi/v1.0/dms/schedule/contents	POST	Erstellt einen neuen Inhaltszeitplan. Ein Inhaltszeitplan kann mehrere Kanäle und Rahmen enthalten. Einen Zeitplan an Geräte übermitteln und die gewünschten Inhalte oder die Wiedergabeliste zu einer bestimmten Zeit wiedergeben.
listDashboardScheduleInfo	/restapi/v1.0/dms/schedule/contents/dashboard	GET	Importiert notwendige Inhaltszeitplaninformationen vom Dashboard.
listContentScheduleByGroup	/restapi/v1.0/dms/schedule/contents/filter	POST	Importiert eine Liste mit anhand der unterschiedlichen Bedingungen gefilterten Inhaltszeitplänen. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.
deleteContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	DELETE	Löscht einen Inhaltszeitplan. Wenn ein Zeitplan gelöscht wird, der zuvor an ein Gerät übermittelt wurde, spielt das Gerät automatisch die Standard-Inhalte ab.
getProgramInfo	/restapi/v1.0/dms/schedule/contents/{programId}	GET	Importiert Details des ausgewählten Zeitplans.
editContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	PUT	Bearbeitet einen Inhaltszeitplan. Wenn ein Zeitplan bearbeitet wird, der zuvor an ein Gerät übermittelt wurde, spielt das Gerät automatisch den bearbeiteten Zeitplan ab.
copyContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/copy	PUT	Kopiert den {programId}-Inhaltszeitplan. Ein Duplikat des {programId}-Inhaltszeitplans wird erstellt.
deployContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/deploy	PUT	Übermittelt einen Inhaltszeitplan an eine bestimmte Gerätegruppe.
getPublishStatus	/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus	GET	Import den Echtzeit-Inhaltszeitplan-Downloadstatus von einem Gerät.
getRootGroups	/restapi/v1.0/dms/schedule/contents/groups	GET	Importiert eine Liste mit Root-Gruppen für einen Inhaltszeitplan.
listContentScheduleGroupInfo	/restapi/v1.0/dms/schedule/contents/groups/{groupId}	GET	Importiert Details der {groupId}-Gruppe.
listAllMessageSchedule	/restapi/v1.0/dms/schedule/messages	GET	Importiert eine Liste aller Nachrichtenzeitpläne.
createMessageSchedule	/restapi/v1.0/dms/schedule/messages	POST	Erstellt einen neuen Nachrichtenzeitplan.
listMessage	/restapi/v1.0/dms/schedule/messages/filter	POST	Importiert eine Liste mit anhand der unterschiedlichen Bedingungen gefilterten Nachrichtenzeitpläne. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.
deleteMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	DELETE	Löscht den ausgewählten Nachrichtenzeitplan. Wenn ein Nachrichtenzeitplan gelöscht wird, der zuvor an ein Gerät übermittelt wurde, wird die Änderung automatisch auf das Gerät angewendet.
getMessageInfo	/restapi/v1.0/dms/schedule/messages/{messageId}	GET	Importiert Details des ausgewählten Nachrichtenzeitplans.
editMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	PUT	Bearbeitet den ausgewählten Nachrichtenzeitplan. Wenn ein Nachrichtenzeitplan bearbeitet wird, der zuvor an ein Gerät übermittelt wurde, wird die Änderung automatisch auf das Gerät angewendet.
copyMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/copy	PUT	Kopiert den ausgewählten Nachrichtenzeitplan. Ein Duplikat des Nachrichtenzeitplans wird erstellt.
deployMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/deploy	PUT	Übermittelt den ausgewählten Nachrichtenzeitplan an eine Gerätegruppe.
getRootGroups	/restapi/v1.0/dms/schedule/messages/groups	GET	Importiert eine Liste mit Root-Gruppen für einen Inhaltszeitplan.
listMessageScheduleGroupInfo	/restapi/v1.0/dms/schedule/messages/groups/{groupId}	GET	Importiert Details der {groupId}-Gruppe.
getChildGroups	/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child	GET	Importiert eine Liste der Untergruppen unter einer bestimmten Gruppe.

Gerät

Geräte steuern und verwalten. Gerätebezogene Dienste sind für authentifizierte Benutzer mit Berechtigungen zum Lesen, Schreiben und Verwalten von Geräten zugänglich.

Die folgenden Geräteverwaltungsdienste sind verfügbar:

Name des Dienstes	API-Aufruf	Ereignistyp	Beschreibung
listAllDevice	/restapi/v1.0/rms/devices	GET	Importiert eine Liste mit allen Geräten. Gerät-Energieversorgungsstatus, Miniaturansichtsinformationen, Gerätefehlerstatus und andere grundlegende Informationen sind in der Liste enthalten. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.
getDashboardDeviceInfo	/restapi/v1.0/rms/devices/dashboard	GET	Importiert notwendige Geräteinformationen aus dem Dashboard.
filterDeviceList	/restapi/v1.0/rms/devices/filter	POST	Importiert eine Liste mit anhand der unterschiedlichen Bedingungen gefilterten Geräten. Listen können pro Seite unter Verwendung von Seiteninformationen importiert werden.
deleteDevice	/restapi/v1.0/rms/devices/{deviceId}	DELETE	Löscht das ausgewählte Gerät.
getDevice	/restapi/v1.0/rms/devices/{deviceId}	GET	Importiert Details des ausgewählten Geräts.
approveDevice	/restapi/v1.0/rms/devices/{deviceId}/approval	PUT	Genehmigt das ausgewählte Video für eine bestimmte Gruppe.
getCabinetList	/restapi/v1.0/rms/devices/{deviceId}/cabinet	POST	Importiert Informationen über Schränke, die mit einem LED-Gerät verbunden sind. Die importierten Informationen gelten nur, wenn die Schränke mit einem LED-Gerät verbunden sind.
updateCabinetInfo	/restapi/v1.0/rms/devices/{deviceId}/cabinet	PUT	Bearbeitet Informationen über Schränke, die mit einem LED-Gerät verbunden sind.
getDisplayControlInfo	/restapi/v1.0/rms/devices/{deviceId}/display	GET	Importiert Geräteanzeigesteuerungsinformationen aus der Datenbank. Falls keine Steuerungsinformationen vorhanden sind, sollte eine Informationsanfrage an das Gerät gesendet werden.
updateDisplayInfo	/restapi/v1.0/rms/devices/{deviceId}/display	PUT	Sendet bearbeitete Anzeigesteuerungsinformationen an ein Gerät. Nur bearbeitete Werte in den Anzeigeinformationen werden als Protokoll an das Gerät gesendet.
getUpdatedDisplayInfoResult	/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}	GET	Empfängt bearbeitete Anzeigesteuerungsinformationen von einem Gerät. Diese API ist ausführbar, nachdem updateDisplayInfo API ausgeführt wurde.
getGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general	GET	Importiert allgemeine Geräteinformationen aus der Datenbank. Allgemeine Geräteinformationen werden aktualisiert, wenn sich das Gerät mit dem Server verbindet.
updateGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general/info	PUT	Sendet bearbeitete Geräteinformationen an ein Gerät. Nur bearbeitete Werte in grundlegenden Geräteinformationen werden als Protokoll an das Gerät gesendet.
getUpdatedGeneralInfoResult	/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}	GET	Erhält bearbeitete Geräteinformationen von einem Gerät. Diese API ist ausführbar, nachdem updateGeneralInfo API ausgeführt wurde.
moveDevice	/restapi/v1.0/rms/devices/{deviceId}/move	PUT	Bewegt ein Gerät in eine andere Gruppe.
startRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/start	GET	Sendet ein RM-Startprotokoll an ein Gerät. Ein Gerät, das ein RM-Startprotokoll empfangen hat, sendet in regelmäßigen Abständen Informationen über den Remote control Server .
stopRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop	GET	Sendet ein RM-Stoppprotokoll an ein Gerät. Ein Gerät, das ein Stoppprotokoll empfangen hat, stoppt sofort die entsprechende Funktion.
getSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	GET	Importiert Geräteeinstellungen. Geräteeinstellungen werden aktualisiert, wenn sich das Gerät mit dem Server verbindet.
updateSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	PUT	Sendet bearbeitete Geräteeinstellungen an ein Gerät. Nur bearbeitete Werte in den Einstellungen werden als Protokoll an das Gerät gesendet.
getUpdatedSetupInfoResult	/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}	GET	Erhält bearbeitete Geräteeinstellungen von einem Gerät. Diese API ist ausführbar, nachdem updateSetupInfo API ausgeführt wurde.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display	GET	Sendet eine aktuelle Anzeigesteuerungsinformationsanfrage an ein Gerät. Wenn diese API aufrufen, wird requestId als der Antwortwert zurückgegeben.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}	GET	Importiert eine Anzeigesteuerungsinformation, die von einem Gerät gesendet wurde. Diese Option wird für zwei Aktionen verwendet: Das Senden einer Anforderung für Informationen an ein Gerät und das Empfangen von tatsächlichen Geräteinformationen.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time	GET	Sendet eine aktuelle Zeitinformationsanfrage an ein Gerät. Wenn diese API aufrufen, wird requestId als der Antwortwert zurückgegeben.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}	GET	Importiert Zeitinformationen, die von einem Gerät gesendet wurden. Diese Option wird für zwei Aktionen verwendet: Das Senden einer Anforderung für Informationen an ein Gerät und das Empfangen von tatsächlichen Geräteinformationen.
getTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	GET	Importiert Gerätezeitinformationen aus der Datenbank. Falls keine Steuerungsinformationen vorhanden sind, sollte eine Informationsanfrage an das Gerät gesendet werden.
updateTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	PUT	Sendet bearbeitete Zeitinformationen an ein Gerät. Nur bearbeitete Werte in den Zeitinformationen werden als Protokoll an das Gerät gesendet.
getUpdatedTimeInfoResult	/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}	GET	Erhält bearbeitete Zeitinformationen von einem Gerät. Diese API ist ausführbar, nachdem getUpdatedTimeInfoResult API ausgeführt wurde.
listDeviceGroupOrgan	/restapi/v1.0/rms/devices/groups	GET	Importiert eine Liste der Organisationen.
listDeviceGroupInfo	/restapi/v1.0/rms/devices/groups/{groupId}	GET	Importiert Details der {groupId}-Gruppe.
listDeviceGroupChild	/restapi/v1.0/rms/devices/groups/{groupId}/child	GET	Importiert Informationen über Untergruppen unter {groupId}.

Benutzer

Benutzer hinzufügen und Benutzerinformationen verwalten. Benutzerbezogene Dienste sind für authentifizierte Benutzer mit Berechtigungen zum Lesen, Schreiben und Verwalten von Benutzerinformationen zugänglich.

Die folgenden Benutzerverwaltungsdienste sind verfügbar:

Name des Dienstes	API-Aufruf	Ereignistyp	Beschreibung
createUser	/restapi/v1.0/ums/users	POST	Fügt einen Benutzer hinzu.
listDashboardUserInfo	/restapi/v1.0/ums/users/dashboard	GET	Importiert notwendige Benutzerinformationen aus dem Dashboard.
updateMyInfo	/restapi/v1.0/ums/users/me	PUT	Bearbeitet Benutzerinformationen.
listUserOrgan	/restapi/v1.0/ums/users/organization	GET	Importiert eine Liste der Organisationen. Diese Option kann verwendet werden, um eine Gruppenstruktur zu konfigurieren.
listUserGroupOrgan	/restapi/v1.0/ums/users/groups	GET	Importiert eine Liste der Organisationen.
listUserGroupInfo	/restapi/v1.0/ums/users/groups/{groupId}	GET	Importiert Details der {groupId}-Gruppe.
listUserGroupChild	/restapi/v1.0/ums/users/groups/{groupId}/child	GET	Importiert eine Liste der Untergruppen unter der {groupId}-Gruppe.

Einstellung

Neben den Hauptfunktionen können Sie viele weitere Funktionen zum Erstellen und Verwalten von Tags und Kategorien verwenden und das Dashboard bearbeiten.

Name des Dienstes	API-Aufruf	Ereignistyp	Beschreibung
getCategoryInfo	/restapi/v1.0/ems/category/{categoryId}	GET	Importiert eine Liste der Kategorien.
deleteDashboard	/restapi/v1.0/ems/dashboard	DELETE	Löscht bestimmte Dashboard-Informationen.
listDashboardInfo	/restapi/v1.0/ems/dashboard	GET	Importiert Inhalte, die auf dem angepassten Dashboard angezeigt werden. Es ist möglich, nur bestimmte Informationen auf dem Dashboard anzuzeigen.
updateDashboardPriority	/restapi/v1.0/ems/dashboard	PUT	Ändert die Reihenfolge der Elemente, die auf dem Dashboard angezeigt werden.
createDashboard	/restapi/v1.0/ems/dashboard/create	GET	Aktiviert ein inaktives Dashboard.
listDashboardLoginInfo	/restapi/v1.0/ems/dashboard/login	GET	Importiert Anmeldeinformationen, die auf dem Dashboard angezeigt werden.
listDashboardNoticeInfo	/restapi/v1.0/ems/dashboard/notice	GET	Importiert Anzeigetafel-Informationen, die auf dem Dashboard angezeigt werden.
deleteNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	DELETE	Löscht einen Beitrag von der Anzeigetafel.
listEditNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	GET	Importiert Details des ausgewählten Beitrags.
createNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	POST	Fügt einen Beitrag zur Anzeigetafel hinzu.
updateNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	PUT	Bearbeitet den ausgewählten Beitrag auf der Anzeigetafel.
listDashboardStorageInfo	/restapi/v1.0/ems/dashboard/storage	GET	Importiert Speicherinformationen, die auf dem Dashboard angezeigt werden.
listLicense	/restapi/v1.0/ems/license	GET	Importiert eine Liste der Lizenzen, die auf dem Server registriert werden.
getServerSetupInfo	/restapi/v1.0/ems/setup	GET	Importiert Servereinstellungen. Servereinstellelemente enthalten Optionen, die verschiedene Funktionen auf dem Server aktivieren oder deaktivieren können.
getTagListInfo	/restapi/v1.0/ems/tag	POST	Importiert eine Liste der Tags, die auf dem Server registriert werden.

Open API-Details (Swagger UI)

Open API Documentation

docExpansion	keine
validatorUrl	keine
operationsSorter	Methode
url	http://184.169.167.38:7001/MagicInfo/v2/api-docs/

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 permite implementar la gestión de contenidos, la gestión de programaciones, la gestión de dispositivos y otras funciones mediante una llamada a Open API (versión 2.0).

Para utilizar Open API (versión 2.0), antes es necesario pasar por un proceso de autenticación. Use una página independiente de Swagger para probar cada API.

Autenticación

Si desea invocar todos los elementos de Open API (versión 2.0), se debe incluir api_token en el encabezado. De lo contrario, se devolverá un error 401 (no autorizado).

Un token obtenido caduca y deja de estar disponible para su uso después de un período de tiempo especificado. Si este es el caso, debe obtener un nuevo token.

Se puede obtener api_token invocando la siguiente API.

Nombre del servicio	Llamada de API	Tipo de llamada	Descripción
authenticationRequest	/auth	POST	Importa un valor de token para la autenticación utilizando el ID y la contraseña de usuario.
authenticationRequest	/auth/refresh	GET	Crea un nuevo token para prolongar el tiempo de caducidad. Es posible llamar a la API REST sin iniciar sesión otra vez.

OPEN API (versión 2.0)

La versión 2.0 de Open API que emplea MagicINFO Server ofrece una serie de funciones. A continuación se muestra la configuración de cada función.

Categoría	Controlador	Descripción
Contenido	content-controller	Gestión de archivos de contenido
Contenido	content-group-controller	Gestión de grupos de contenido
Lista de reproducción	playlist-controller	Gestión de listas de reproducción
Lista de reproducción	playlist-group-controller	Gestión de grupos de listas de reproducción
Programación	content-schedule-controller	Gestión de programaciones de contenidos
	content-schedule-group-controller	Gestión de grupos de programaciones de contenidos
	message-schedule-controller	Administración de la programación de mensajes
	message-schedule-group-controller	Gestión de grupos de programaciones de mensajes
Dispositivo	device-controller	Administración de dispositivos
Dispositivo	device-group-controller	Gestión de grupos de dispositivos
Usu.	user-controller	Administración de usuarios
Usu.	user-group-controller	Gestión de grupos de usuarios
Configuración	environment-controller	Configuración

Contenido

Cargar, aprobar o eliminar contenido. Gestionar listas de contenido. Los usuarios autenticados con privilegios para leer, escribir y gestionar contenidos pueden acceder a los servicios relacionados con el contenido.

Los servicios de gestión de contenidos disponibles son los siguientes:

Nombre del servicio	Llamada de API	Tipo de llamada	Descripción
listAllContent	/restapi/v1.0/cms/contents	GET	Importa una lista del contenido cargado. Las miniaturas de contenido, los nombres, los tipos de archivos y otra información básica se incluyen en la lista. Las listas se pueden importar por página mediante la información de paginación.
listDashboardContentInfo	/restapi/v1.0/cms/contents/dashboard	GET	Importa información general de contenido que se mostrará en el panel.
listContent	/restapi/v1.0/cms/contents/filter	POST	Importa una lista de contenido filtrado de acuerdo con condiciones. Las listas se pueden importar por página mediante la información de paginación.
forceDeleteContent	/restapi/v1.0/cms/contents/force/{contentId}	DELETE	Borra el contenido, tanto si está incluido en una lista de reproducción o una programación como si no.
deleteContent	/restapi/v1.0/cms/contents/{contentId}	DELETE	Elimina el contenido después de comprobar que no está incluido en una lista de reproducción o una programación. Si intenta eliminar contenido incluido en una lista de reproducción o una programación, no se eliminará y se devolverá un código de error.
getActiveContentInfo	/restapi/v1.0/cms/contents/{contentId}	GET	Importa detalles sobre una versión de contenido activada. La versión de contenido se actualiza cada vez que el contenido se edita.
approveContents	/restapi/v1.0/cms/contents/{contentId}/approval	PUT	Aprueba/rechaza el contenido. El contenido aprobado se mueve a la lista de contenido general y se puede utilizar en listas de reproducción o programaciones.
uploadContent	/restapi/v1.0/cms/contents/{groupId}	POST	Carga contenido nuevo.
listDefaultGroup	/restapi/v1.0/cms/contents/groups	GET	Importa una lista de grupos de contenido predeterminados.
getGroup	/restapi/v1.0/cms/contents/groups/{groupId}	GET	Importa detalles sobre el grupo {groupId}.
listChildGroup	/restapi/v1.0/cms/contents/groups/{groupId}/child	GET	Importa una lista de subgrupos contenidos en el grupo {groupId}.

Lista de reproducción

Utilice el contenido para crear, editar o borrar listas de reproducción. Los usuarios autenticados con privilegios para leer, escribir y gestionar contenido pueden acceder a los servicios relacionados con las listas de reproducción.

Los servicios de gestión de listas de reproducción disponibles son los siguientes:

Nombre del servicio	Llamada de API	Tipo de llamada	Descripción
listAllPlaylist	/restapi/v1.0/cms/playlists	GET	Importa una lista de todas listas de reproducción. En la lista se incluyen los nombres de las listas de reproducción, las miniaturas de contenido principal, los tipos de listas de reproducción y otra información básica. Las listas se pueden importar por página mediante la información de paginación.
createPlaylist	/restapi/v1.0/cms/playlists	POST	Crea una nueva lista de reproducción.
getDashboardPlaylistInfo	/restapi/v1.0/cms/playlists/dashboard	GET	Importa la información de lista de reproducción necesaria del panel.
listPlaylist	/restapi/v1.0/cms/playlists/filter	POST	Importa una lista de listas de reproducción filtradas de acuerdo con condiciones. Las listas se pueden importar por página mediante la información de paginación.
deletePlaylist	/restapi/v1.0/cms/playlists/{playlistId}	DELETE	Elimina la lista de reproducción seleccionada. Si intenta eliminar una lista de reproducción incluida en una programación, no se eliminará y se devolverá un código de error.
getActivePlaylistInfo	/restapi/v1.0/cms/playlists/{playlistId}	GET	Importa detalles sobre una versión activada de una lista de reproducción. La versión de una lista de reproducción se actualiza cada vez que se edita la lista de reproducción.
editPlaylist	/restapi/v1.0/cms/playlists/{playlistId}	PUT	Edita la lista de reproducción {playlistId}. La edición de una lista de reproducción provoca la actualización de la versión de la lista de reproducción y hace que el dispositivo de reproducción reproduzca automáticamente la lista de reproducción actualizada.
copyPlaylist	/restapi/v1.0/cms/playlists/{playlistId}/copy	PUT	Copia la lista de reproducción {playlistId}. Se crea una copia duplicada de la lista de reproducción.
listDefaultGroup	/restapi/v1.0/cms/playlists/groups	GET	Importa una lista de los grupos predeterminados de la lista de reproducción.
getGroup	/restapi/v1.0/cms/playlists/groups/{groupId}	GET	Importa detalles sobre el grupo {groupId}.
listChildGroup	/restapi/v1.0/cms/playlists/groups/{groupId}/child	GET	Importa una lista de subgrupos contenidos en el grupo {groupId}.

Programación

Cree nuevas programaciones de contenido o mensajes. Publique programaciones en dispositivos para su reproducción. Edite o elimine programaciones.

Los usuarios autenticados con privilegios para leer, escribir y gestionar programaciones pueden acceder a los servicios relacionados con las programaciones.

Los servicios de gestión de programaciones disponibles son los siguientes:

Nombre del servicio	Llamada de API	Tipo de llamada	Descripción
listContentScheduleAll	/restapi/v1.0/dms/schedule/contents	GET	Importa una lista de todas las programaciones de contenido. En la lista se incluyen los nombres de las programaciones, las fechas de creación, los tipos de dispositivos y otra información básica. Las listas se pueden importar por página mediante la información de paginación.
createContentSchedule	/restapi/v1.0/dms/schedule/contents	POST	Crea una nueva programación de contenido. Una programación de contenido puede contener varios canales y marcos. Publique una programación en los dispositivos y reproduzca el contenido deseado o una lista de reproducción en un momento especificado.
listDashboardScheduleInfo	/restapi/v1.0/dms/schedule/contents/dashboard	GET	Importa información de programación de contenido necesaria del panel.
listContentScheduleByGroup	/restapi/v1.0/dms/schedule/contents/filter	POST	Importa una lista de programaciones de contenido filtrada de acuerdo con diferentes condiciones. Las listas se pueden importar por página mediante la información de paginación.
deleteContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	DELETE	Elimina una programación de contenido. Si elimina una programación previamente publicada en un dispositivo, el dispositivo reproduce automáticamente el contenido predeterminado.
getProgramInfo	/restapi/v1.0/dms/schedule/contents/{programId}	GET	Importa detalles sobre la programación seleccionada.
editContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	PUT	Edita una programación de contenido. Si edita una programación publicada previamente en un dispositivo, el dispositivo reproduce automáticamente la programación editada.
copyContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/copy	PUT	Copia la programación de contenido {programId}. Se crea una copia duplicada de la programación de contenido {programId}.
deployContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/deploy	PUT	Publica una programación de contenido en un grupo de dispositivos específico.
getPublishStatus	/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus	GET	Importa el estado de descarga de la programación de contenido en tiempo real desde un dispositivo.
getRootGroups	/restapi/v1.0/dms/schedule/contents/groups	GET	Importa una lista de grupos raíz para una programación de contenido.
listContentScheduleGroupInfo	/restapi/v1.0/dms/schedule/contents/groups/{groupId}	GET	Importa detalles sobre el grupo {groupId}.
listAllMessageSchedule	/restapi/v1.0/dms/schedule/messages	GET	Importa una lista de todas las programaciones de mensajes.
createMessageSchedule	/restapi/v1.0/dms/schedule/messages	POST	Crea una nueva programación de mensajes.
listMessage	/restapi/v1.0/dms/schedule/messages/filter	POST	Importa una lista de programaciones de mensajes filtrada según diferentes condiciones. Las listas se pueden importar por página mediante la información de paginación.
deleteMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	DELETE	Borra la programación de mensajes seleccionada. Si elimina una programación de mensajes anteriormente publicada en un dispositivo, el cambio se aplica automáticamente al dispositivo.
getMessageInfo	/restapi/v1.0/dms/schedule/messages/{messageId}	GET	Importa detalles sobre la programación de mensajes seleccionada.
editMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	PUT	Modifica la programación de mensajes seleccionada. Si edita una programación de mensajes publicada previamente en un dispositivo, el cambio se aplica automáticamente al dispositivo.
copyMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/copy	PUT	Copia la programación de mensajes seleccionada. Se crea una copia duplicada de la programación de mensajes.
deployMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/deploy	PUT	Publica la programación de mensajes seleccionada en un grupo de dispositivos.
getRootGroups	/restapi/v1.0/dms/schedule/messages/groups	GET	Importa una lista de grupos raíz para una programación de contenido.
listMessageScheduleGroupInfo	/restapi/v1.0/dms/schedule/messages/groups/{groupId}	GET	Importa detalles sobre el grupo {groupId}.
getChildGroups	/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child	GET	Importa una lista de subgrupos incluidos en un grupo específico.

Dispositivo

Controle y gestione los dispositivos. Los usuarios autenticados con privilegios para leer, escribir y gestionar dispositivos pueden acceder a los servicios relacionados con los dispositivos.

Los servicios de gestión de dispositivos disponibles son los siguientes:

Nombre del servicio	Llamada de API	Tipo de llamada	Descripción
listAllDevice	/restapi/v1.0/rms/devices	GET	Importa una lista de todos los dispositivos. En la lista se incluyen el estado de alimentación del dispositivo, la información sobre las miniaturas, el estado de error de dispositivo y otra información básica. Las listas se pueden importar por página mediante la información de paginación.
getDashboardDeviceInfo	/restapi/v1.0/rms/devices/dashboard	GET	Importa la información de dispositivo necesaria del panel.
filterDeviceList	/restapi/v1.0/rms/devices/filter	POST	Importa una lista de dispositivos filtrada según diferentes condiciones. Las listas se pueden importar por página mediante la información de paginación.
deleteDevice	/restapi/v1.0/rms/devices/{deviceId}	DELETE	Borra el dispositivo seleccionado.
getDevice	/restapi/v1.0/rms/devices/{deviceId}	GET	Importa detalles sobre el dispositivo seleccionado.
approveDevice	/restapi/v1.0/rms/devices/{deviceId}/approval	PUT	Aprueba el dispositivo seleccionado en un grupo específico.
getCabinetList	/restapi/v1.0/rms/devices/{deviceId}/cabinet	POST	Importa información sobre las vitrinas conectadas a un dispositivo LED. La información importada solo es válida cuando las vitrinas están conectadas a un dispositivo LED.
updateCabinetInfo	/restapi/v1.0/rms/devices/{deviceId}/cabinet	PUT	Edita la información sobre las vitrinas conectadas a un dispositivo LED.
getDisplayControlInfo	/restapi/v1.0/rms/devices/{deviceId}/display	GET	Importa información sobre el control de visualización de dispositivos de la base de datos. Si no hay información de control, se debe enviar una solicitud de información al dispositivo.
updateDisplayInfo	/restapi/v1.0/rms/devices/{deviceId}/display	PUT	Envía la información sobre el control de visualización editada a un dispositivo. Se envían solo los valores editados de la información de visualización como un protocolo al dispositivo.
getUpdatedDisplayInfoResult	/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}	GET	Recibe la información sobre el control de visualización editada de un dispositivo. Esta API se puede ejecutar después de la ejecución de la API updateDisplayInfo.
getGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general	GET	Importa información general del dispositivo desde la base de datos. La información general del dispositivo se actualiza cuando el dispositivo se conecta al servidor.
updateGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general/info	PUT	Envía la información de dispositivo editada a un dispositivo. Se envían solo los valores editados de la información de dispositivo básica a modo de protocolo al dispositivo.
getUpdatedGeneralInfoResult	/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}	GET	Recibe la información del dispositivo editada desde un dispositivo. Esta API se puede ejecutar después de la ejecución de la API updateGeneralInfo.
moveDevice	/restapi/v1.0/rms/devices/{deviceId}/move	PUT	Mueve un dispositivo a otro grupo.
startRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/start	GET	Envía un protocolo de inicio de gestión remota a un dispositivo. Un dispositivo que recibe un protocolo de inicio de gestión remota envía información periódicamente a través del servidor de gestión remota.
stopRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop	GET	Envía un protocolo de detención de gestión remota a un dispositivo. Un dispositivo que recibe un protocolo de detención detiene inmediatamente la función correspondiente.
getSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	GET	Importa la configuración del dispositivo. La configuración del dispositivo se actualiza cuando el dispositivo se conecta al servidor.
updateSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	PUT	Envía la configuración de dispositivo editada a un dispositivo. Se envían solo los valores editados de la configuración a modo de protocolo al dispositivo.
getUpdatedSetupInfoResult	/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}	GET	Recibe la configuración de dispositivo editada de un dispositivo. Esta API se puede ejecutar después de la ejecución de la API updateSetupInfo.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display	GET	Envía una solicitud de información de control de visualización actual a un dispositivo. Si se llama a esta API, se devuelve requestId como valor de respuesta.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}	GET	Importa la información de control de dispositivo enviada desde un dispositivo. Esta opción se utiliza para dos acciones: enviar una solicitud de información a un dispositivo y recibir la información real del dispositivo.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time	GET	Envía una solicitud de información de la hora actual a un dispositivo. Si se llama a esta API, se devuelve requestId como valor de respuesta.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}	GET	Importa la información temporal enviada desde un dispositivo. Esta opción se utiliza para dos acciones: enviar una solicitud de información a un dispositivo y recibir la información real del dispositivo.
getTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	GET	Importa la información temporal de dispositivo de la base de datos. Si no hay información de control, se debe enviar una solicitud de información al dispositivo.
updateTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	PUT	Envía la información temporal editada a un dispositivo. Se envían solo los valores editados de la información temporal a modo de protocolo al dispositivo.
getUpdatedTimeInfoResult	/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}	GET	Recibe la información temporal editada desde un dispositivo. Esta API se puede ejecutar después de la ejecución de la API getUpdatedTimeInfoResult.
listDeviceGroupOrgan	/restapi/v1.0/rms/devices/groups	GET	Importa una lista de organizaciones.
listDeviceGroupInfo	/restapi/v1.0/rms/devices/groups/{groupId}	GET	Importa detalles sobre el grupo {groupId}.
listDeviceGroupChild	/restapi/v1.0/rms/devices/groups/{groupId}/child	GET	Importa la información sobre los subgrupos de {groupId}.

Usu.

Agregue usuarios y gestione la información de usuario. Los usuarios autenticados con privilegios para leer, escribir y gestionar información de usuario pueden acceder a los servicios relacionados con los usuarios.

Los servicios de gestión de usuarios disponibles son los siguientes:

Nombre del servicio	Llamada de API	Tipo de llamada	Descripción
createUser	/restapi/v1.0/ums/users	POST	Añade un usuario.
listDashboardUserInfo	/restapi/v1.0/ums/users/dashboard	GET	Importa la información de usuario necesaria desde el panel.
updateMyInfo	/restapi/v1.0/ums/users/me	PUT	Edita la información de usuario.
listUserOrgan	/restapi/v1.0/ums/users/organization	GET	Importa una lista de organizaciones. Esta opción se puede utilizar para configurar un árbol de grupos.
listUserGroupOrgan	/restapi/v1.0/ums/users/groups	GET	Importa una lista de organizaciones.
listUserGroupInfo	/restapi/v1.0/ums/users/groups/{groupId}	GET	Importa detalles sobre el grupo {groupId}.
listUserGroupChild	/restapi/v1.0/ums/users/groups/{groupId}/child	GET	Importa una lista de subgrupos contenidos en el grupo {groupId}.

Configuración

Además de las funciones principales, puede utilizar muchas otras funciones para crear y gestionar etiquetas y categorías, así como editar el panel.

Nombre del servicio	Llamada de API	Tipo de llamada	Descripción
getCategoryInfo	/restapi/v1.0/ems/category/{categoryId}	GET	Importa una lista de categorías.
deleteDashboard	/restapi/v1.0/ems/dashboard	DELETE	Elimina la información de un panel específico.
listDashboardInfo	/restapi/v1.0/ems/dashboard	GET	Importa el contenido que se mostrará en el panel personalizado. Es posible visualizar solo información específica en el panel.
updateDashboardPriority	/restapi/v1.0/ems/dashboard	PUT	Cambia el orden de los elementos que se muestran en el panel.
createDashboard	/restapi/v1.0/ems/dashboard/create	GET	Activa un panel inactivo.
listDashboardLoginInfo	/restapi/v1.0/ems/dashboard/login	GET	Importa la información de inicio de sesión que aparecerá en el panel.
listDashboardNoticeInfo	/restapi/v1.0/ems/dashboard/notice	GET	Importa la información del tablón de anuncios que se mostrará en el panel.
deleteNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	DELETE	Elimina una publicación del tablón de anuncios.
listEditNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	GET	Importa los detalles de la publicación seleccionada.
createNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	POST	Agrega publicaciones al tablón de anuncios.
updateNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	PUT	Edita la publicación seleccionada en el tablón de anuncios.
listDashboardStorageInfo	/restapi/v1.0/ems/dashboard/storage	GET	Importa la información de almacenamiento que se mostrará en el panel.
listLicense	/restapi/v1.0/ems/license	GET	Importa una lista de las licencias registradas en el servidor.
getServerSetupInfo	/restapi/v1.0/ems/setup	GET	Importa la configuración del servidor. Los elementos de configuración del servidor incluyen opciones que permiten activar o desactivar diferentes funciones en el servidor.
getTagListInfo	/restapi/v1.0/ems/tag	POST	Importa una lista de etiquetas registradas en el servidor.

Detalles de Open API (interfaz de usuario de Swagger)

Open API Documentation

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

Sv translation

language	pl

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

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

Uwierzytelnianie

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

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

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

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

OPEN API (v2.0)

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

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

Treści

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

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

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

Lista odtwarzania

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

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

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

Harmonogram

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

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

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

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

Urządzenie

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

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

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

Użytkownik

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

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

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

Ustawienia

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

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

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

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

Sv translation

language	ar

يتيح لك خادم MagicINFO Server تنفيذ إدارة المحتوى وإدارة الجدول وإدارة الجهاز وغيرها من الوظائف الأخرى باستدعاء واجهة برمجة التطبيقات المفتوحة (الإصدار 2.0).

لاستخدام واجهة برمجة التطبيقات المفتوحة (الإصدار 2.0)، ستحتاج أوّلاً إلى تجاوز عملية المصادقة. استخدم صفحة Swagger منفصلة لاختبار كل واجهة برمجة تطبيقات.

التصديق

عند استدعاء جميع عناصر واجهة برمجة التطبيقات المفتوحة (الإصدار 2.0)، يجب تضمين api_token في العنوان الرئيس. وفي حالة عدم تضمينه، سيؤدي ذلك إلى ظهور الخطأ "‎401 Unauthorized".

تنتهي صلاحية الرمز المميّز المحصول عليه ويصبح غير متاح للاستخدام بعد فترة زمنية معينة. وفي هذه الحالة، يجب عليك الحصول على رمز مميّز جديد.

يمكن الحصول على api_token باستدعاء واجهة برمجة التطبيقات.

اسم الخدمة	استدعاء API	نوع الاستدعاء	الوصف
طلب المصادقة	/auth	نشر	استيراد قيمة الرمز المميّز للمصادقة باستخدام هوية المستخدم وكلمة المرور.
طلب المصادقة	/auth/refresh	الحصول	إنشاء رمز مميّز جديد لتمديد وقت انتهاء الصلاحية. من الممكن استدعاء REST API دون تسجيل الدخول مرّة أخرى.

واجهة برمجة التطبيقات المفتوحة (الإصدار 2.0)

توفر واجهة برمجة التطبيقات المفتوحة (الإصدار 2.0) لخادم MagicINFO Server العديد من الوظائف المختلفة. ونستعرض فيما يلي تكوين كل وظيفة من الوظائف.

الفئة	عنصر التحكّم	الوصف
المحتوى.	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	الحصول	استيراد قائمة بالمحتوى الذي تم تحميله. تكون الصور المصغرة للمحتوى والأسماء وأنواع الملفات وغيرها من المعلومات الأساسية الأخرى متضمنة في القائمة. يمكن استيراد القوائم لكل صفحة باستخدام معلومات الترحيل.
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	نشر	إنشاء جدول رسالة جديد.
إدراج الرسالة	/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}	الحصول	تلقّي معلومات التحكّم في العرض التي تم تحريرها من جهاز. تكون واجهة برمجة التطبيقات هذه قابلة للتنفيذ بعد تنفيذ خدمة تحديث معلومات العرض.
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}	الحصول	تلقّي معلومات الجهاز التي تم تحريرها من جهاز. تكون واجهة برمجة التطبيقات هذه قابلة للتنفيذ بعد تنفيذ خدمة تحديث المعلومات العامة.
moveDevice	/restapi/v1.0/rms/devices/{deviceId}/move	وضع	نقل جهاز إلى مجموعة أخرى.
startRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/start	الحصول	إرسال بروتوكول بدء وضع إعادة التعيين إلى جهاز. يرسل جهاز تلقّى بروتوكول بدء وضع إعادة التعيين معلومات دوريّة عبر خادم جهاز التحكم عن بعد.
stopRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop	الحصول	إرسال بروتوكول إيقاف وضع إعادة التعيين إلى جهاز. يوقف جهاز تلقّى بروتوكول الإيقاف الوظيفة المطابقة في الحال.
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}	الحصول	تلقّإعدادات معلومات الجهاز التي تم تحريرها من جهاز. تكون واجهة برمجة التطبيقات هذه قابلة للتنفيذ بعد تنفيذ خدمة تحديث معلومات الإعداد.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display	الحصول	إرسال طلب معلومات التحكّم في العرض الحالي إلى جهاز. في حالة استدعاء واجهة برمجة التطبيقات هذه، تكون النتيجة تلقّي معرّف الطلب كقيمة الاستجابة.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}	الحصول	استيراد معلومات التحكّم في العرض المُرسلة من جهاز. يُستخدم هذا الخيار لإجراءين اثنين: إرسال طلب الحصول على معلومات إلى جهاز وتلقّي معلومات الجهاز الفعلية.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time	الحصول	إرسال طلب معلومات الوقت الحالي إلى جهاز. في حالة استدعاء واجهة برمجة التطبيقات هذه، تكون النتيجة تلقّي معرّف الطلب كقيمة الاستجابة.
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}	الحصول	تلقّي معلومات وقت الجهاز التي تم تحريرها من جهاز. تكون واجهة برمجة التطبيقات هذه قابلة للتنفيذ بعد تنفيذ خدمة الحصول على نتيجة معلومات الوقت المحدّثة.
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	نشر	استيراد قائمة العلامات المسجلة على الخادم.

تفاصيل واجهة برمجة التطبيقات المفتوحة (واجهة مستخدم Swagger)

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

Sv translation

language	fr

MagicINFO Server vous permet de mettre en place une gestion du contenu, une gestion des programmes, une gestion des périphériques et d’autres fonctions en appelant Open API (v2.0).

Pour utiliser Open API (v2.0), vous devez d’abord effectuer un processus d’authentification. Utilisez une page Swagger distincte pour tester chaque API.

Authentification

Lorsque vous appelez tous les éléments Open API (v2.0), vous devez inclure api_token dans l’en-tête. Si ceci n’est pas inclus, une erreur « 401 Unauthorized » est renvoyée.

Un jeton obtenu expire et devient inutilisable après une durée définie. Si tel est le cas, vous devez obtenir un nouveau jeton.

Il est possible d’obtenir api_token en appelant l’API suivante.

Nom du service	Requête API	Type de requête	Description
authenticationRequest	/auth	POST	Importe une valeur de jeton pour l’authentification à l’aide de l’identifiant d’utilisateur et du mot de passe.
authenticationRequest	/auth/refresh	GET	Crée un nouveau jeton pour étendre le délai d’expiration. Il est possible d’appeler REST API sans se reconnecter

OPEN API (v2.0)

MagicINFO Server Open API (v2.0) fournit diverses fonctions. La configuration de chaque fonction est indiquée ci-dessous.

Catégorie	Contrôleur	Description
Contenu :	content-controller	Gestion du contenu
Contenu :	content-group-controller	Gestion du groupe de contenu
Liste de lecture	playlist-controller	Gestion des listes de lecture
Liste de lecture	playlist-group-controller	Gestion du groupe de listes de lecture
Programme	content-schedule-controller	Gestion du programme de contenu
	content-schedule-group-controller	Gestion du groupe de programmes de contenu
	message-schedule-controller	Gestion des programmes de messages
	message-schedule-group-controller	Gestion du groupe de programmes de message
Périphérique	device-controller	Gestion des périphériques
Périphérique	device-group-controller	Gestion du groupe de périphériques
Utilisateur	user-controller	Gestion des utilisateurs
Utilisateur	user-group-controller	Gestion du groupe d’utilisateurs
Réglage	environment-controller	Réglage

Contenu :

Téléchargez, approuvez ou supprimez du contenu. Gérez des listes de contenu. Les services relatifs au contenu sont accessibles pour les utilisateurs authentifiés possédant les privilèges nécessaires pour lire, écrire et gérer du contenu.

Les services disponibles de gestion de contenu sont comme suit :

Nom du service	Requête API	Type de requête	Description
listAllContent	/restapi/v1.0/cms/contents	GET	Permet d’importer une liste du contenu téléchargé. La liste inclut les vignettes de contenu, les noms, les types de fichiers et d’autres informations de base. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
listDashboardContentInfo	/restapi/v1.0/cms/contents/dashboard	GET	Permet d’importer des informations de contenu générales à afficher sur le tableau de bord.
listContent	/restapi/v1.0/cms/contents/filter	POST	Permet d’importer une liste de contenu filtré selon des conditions. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
forceDeleteContent	/restapi/v1.0/cms/contents/force/{contentId}	DELETE	Supprime du contenu, que le contenu soit inclus ou non dans une liste de lecture ou un programme.
deleteContent	/restapi/v1.0/cms/contents/{contentId}	DELETE	Supprime du contenu après avoir vérifié que le contenu n’est pas inclus dans une liste de lecture ou un programme. Si vous tentez de supprimer du contenu inclus dans une liste de lecture ou un programme, le contenu n’est pas supprimé et un code d’erreur est renvoyé.
getActiveContentInfo	/restapi/v1.0/cms/contents/{contentId}	GET	Permet d’importer les détails d’une version activée du contenu. La version du contenu est mise à jour à chaque fois que le contenu est modifié.
approveContents	/restapi/v1.0/cms/contents/{contentId}/approval	PUT	Permet d’approuver/de rejeter du contenu. Le contenu approuvé est déplacé dans la liste de contenu général et peut être utilisé dans des listes de lecture ou des programmes.
uploadContent	/restapi/v1.0/cms/contents/{groupId}	POST	Permet de télécharger du nouveau contenu.
listDefaultGroup	/restapi/v1.0/cms/contents/groups	GET	Permet d’importer une liste des groupes de contenu par défaut.
getGroup	/restapi/v1.0/cms/contents/groups/{groupId}	GET	Permet d’importer les détails du groupe {groupId}.
listChildGroup	/restapi/v1.0/cms/contents/groups/{groupId}/child	GET	Permet d’importer une liste de sous-groupes dans le groupe {groupId}.

Liste de lecture

Utilisez du contenu pour créer, modifier ou supprimer des listes de lecture. Les services relatifs aux listes de lecture sont accessibles pour les utilisateurs authentifiés possédant les privilèges nécessaires pour lire, écrire et gérer du contenu.

Les services disponibles de gestion de liste de lecture sont comme suit :

Nom du service	Requête API	Type de requête	Description
listAllPlaylist	/restapi/v1.0/cms/playlists	GET	Permet d’importer une liste de toutes les listes de lecture. La liste inclut les noms des listes de lecture, les vignettes de contenu principales, les types de listes de lecture et d’autres informations de base. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
createPlaylist	/restapi/v1.0/cms/playlists	POST	Crée une nouvelle liste de lecture.
getDashboardPlaylistInfo	/restapi/v1.0/cms/playlists/dashboard	GET	Permet d’importer depuis le tableau de bord des informations de liste de lecture indispensables.
listPlaylist	/restapi/v1.0/cms/playlists/filter	POST	Permet d’importer une liste des listes de lecture filtrées selon des conditions. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
deletePlaylist	/restapi/v1.0/cms/playlists/{playlistId}	DELETE	Supprime la liste de lecture sélectionnée. Si vous tentez de supprimer une liste de lecture incluse dans un programme, la liste de lecture n’est pas supprimée et un code d’erreur est renvoyé.
getActivePlaylistInfo	/restapi/v1.0/cms/playlists/{playlistId}	GET	Permet d’importer les détails d’une version activée d’une liste de lecture. La version d’une liste de lecture est mise à jour à chaque fois que cette liste de lecture est modifiée.
editPlaylist	/restapi/v1.0/cms/playlists/{playlistId}	PUT	Modifie la liste de lecture {playlistId}. La modification d’une liste de lecture actualise la version de cette liste de lecture. Ainsi, le périphérique lisant la liste de lecture lit automatiquement la version mise à jour.
copyPlaylist	/restapi/v1.0/cms/playlists/{playlistId}/copy	PUT	Copie la liste de lecture {playlistId}. Un duplicata de la liste de lecture est créé.
listDefaultGroup	/restapi/v1.0/cms/playlists/groups	GET	Permet d’importer une liste des groupes de listes de lecture par défaut.
getGroup	/restapi/v1.0/cms/playlists/groups/{groupId}	GET	Permet d’importer les détails du groupe {groupId}.
listChildGroup	/restapi/v1.0/cms/playlists/groups/{groupId}/child	GET	Permet d’importer une liste de sous-groupes dans le groupe {groupId}.

Programme

Créez de nouveaux programmes de contenu ou de message. Publiez des programmes sur des périphériques pour la lecture. Modifiez ou supprimez des programmes.

Les services relatifs aux programmes sont accessibles pour les utilisateurs authentifiés possédant les privilèges nécessaires pour lire, écrire et gérer des programmes.

Les services disponibles de gestion de programme sont comme suit :

Nom du service	Requête API	Type de requête	Description
listContentScheduleAll	/restapi/v1.0/dms/schedule/contents	GET	Permet d’importer une liste de tous les programmes de contenu. La liste inclut les noms des programmes de contenu, les dates de création, les types de périphériques et d’autres informations de base. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
createContentSchedule	/restapi/v1.0/dms/schedule/contents	POST	Permet de créer un nouveau programme de contenu. Un programme de contenu peut contenir plusieurs canaux et cadres. Publiez un programme sur des périphériques et lisez le contenu souhaité ou la liste de lecture à un moment spécifié.
listDashboardScheduleInfo	/restapi/v1.0/dms/schedule/contents/dashboard	GET	Permet d’importer depuis le tableau de bord des informations de programme de contenu indispensables.
listContentScheduleByGroup	/restapi/v1.0/dms/schedule/contents/filter	POST	Permet d’importer une liste de programmes de contenu filtrés selon différentes conditions. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
deleteContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	DELETE	Supprime un programme de contenu. En cas de suppression d’un programme précédemment publié sur un périphérique, le périphérique lit automatiquement le contenu par défaut.
getProgramInfo	/restapi/v1.0/dms/schedule/contents/{programId}	GET	Permet d’importer les détails du programme sélectionné.
editContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	PUT	Permet de modifier un programme de contenu. En cas de modification d’un programme précédemment publié sur un périphérique, le périphérique lit automatiquement le programme modifié.
copyContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/copy	PUT	Permet de copier le programme de contenu {programId}. Un duplicata du programme de contenu {programId} est créé.
deployContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/deploy	PUT	Permet de publier un programme de contenu sur un groupe de périphériques spécifique.
getPublishStatus	/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus	GET	Permet d’importer le statut de téléchargement en temps réel d’un programme de contenu depuis un périphérique.
getRootGroups	/restapi/v1.0/dms/schedule/contents/groups	GET	Permet d’importer une liste de tous les groupes de racine pour un programme de contenu.
listContentScheduleGroupInfo	/restapi/v1.0/dms/schedule/contents/groups/{groupId}	GET	Permet d’importer les détails du groupe {groupId}.
listAllMessageSchedule	/restapi/v1.0/dms/schedule/messages	GET	Permet d’importer une liste de tous les programmes de message.
createMessageSchedule	/restapi/v1.0/dms/schedule/messages	POST	Permet de créer un nouveau programme de message.
listMessage	/restapi/v1.0/dms/schedule/messages/filter	POST	Permet d’importer une liste de programmes de message filtrés selon différentes conditions. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
deleteMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	DELETE	Supprime le programme de message sélectionné. En cas de suppression d’un programme de message précédemment publié sur un périphérique, la modification est appliquée automatiquement au périphérique.
getMessageInfo	/restapi/v1.0/dms/schedule/messages/{messageId}	GET	Permet d’importer les détails du programme de message sélectionné.
editMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	PUT	Permet d’éditer le programme de message sélectionné. En cas de modification d’un programme de message précédemment publié sur un périphérique, la modification est appliquée automatiquement au périphérique.
copyMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/copy	PUT	Permet de copier le programme de message sélectionné. Un duplicata du programme de message est créé.
deployMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/deploy	PUT	Permet de publier le programme de message sélectionné sur un groupe de périphériques.
getRootGroups	/restapi/v1.0/dms/schedule/messages/groups	GET	Permet d’importer une liste de tous les groupes de racine pour un programme de contenu.
listMessageScheduleGroupInfo	/restapi/v1.0/dms/schedule/messages/groups/{groupId}	GET	Permet d’importer les détails du groupe {groupId}.
getChildGroups	/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child	GET	Permet d’importer une liste de sous-groupes dans un groupe spécifique.

Périphérique

Contrôlez et gérez les périphériques. Les services relatifs aux périphériques sont accessibles pour les utilisateurs authentifiés possédant les privilèges nécessaires pour lire, écrire et gérer des périphériques.

Les services disponibles de gestion de périphérique sont comme suit :

Nom du service	Requête API	Type de requête	Description
listAllDevice	/restapi/v1.0/rms/devices	GET	Permet d’importer une liste de tous les périphériques. La liste inclut l’état d’alimentation du périphérique, les informations de vignette, le statut d’erreur du périphérique et d’autres informations de base. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
getDashboardDeviceInfo	/restapi/v1.0/rms/devices/dashboard	GET	Permet d’importer depuis le tableau de bord des informations de périphérique indispensables.
filterDeviceList	/restapi/v1.0/rms/devices/filter	POST	Permet d’importer une liste de périphériques filtrés selon différentes conditions. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
deleteDevice	/restapi/v1.0/rms/devices/{deviceId}	DELETE	Supprime le périphérique sélectionné.
getDevice	/restapi/v1.0/rms/devices/{deviceId}	GET	Permet d’importer les détails du périphérique sélectionné.
approveDevice	/restapi/v1.0/rms/devices/{deviceId}/approval	PUT	Permet d’approuver le périphérique sélectionné sur un groupe spécifique.
getCabinetList	/restapi/v1.0/rms/devices/{deviceId}/cabinet	POST	Permet d’importer des informations sur les cabinets connectés à un périphérique LED. Les informations importées sont valides uniquement lorsque les cabinets sont connectés à un périphérique LED.
updateCabinetInfo	/restapi/v1.0/rms/devices/{deviceId}/cabinet	PUT	Permet de modifier des informations sur les cabinets connectés à un périphérique LED.
getDisplayControlInfo	/restapi/v1.0/rms/devices/{deviceId}/display	GET	Permet d’importer des informations de contrôle d’affichage du périphérique depuis la base de données. S’il n’y a pas d’informations de contrôle, une requête d’informations doit être envoyée au périphérique.
updateDisplayInfo	/restapi/v1.0/rms/devices/{deviceId}/display	PUT	Permet d’envoyer sur un périphérique des informations de contrôle d’affichage modifiées. Seules les valeurs modifiées dans les informations d’affichage sont envoyées au périphérique en tant que protocole.
getUpdatedDisplayInfoResult	/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}	GET	Permet de recevoir depuis un périphérique des informations de contrôle d’affichage modifiées. Cette API peut être exécutée après l’exécution de l’API updateDisplayInfo.
getGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general	GET	Permet d’importer des informations de périphérique générales depuis la base de données. Les informations de périphérique générales sont actualisées lorsque le périphérique se connecte au serveur.
updateGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general/info	PUT	Permet d’envoyer sur un périphérique des informations de périphérique modifiées. Seules les valeurs modifiées dans les informations de périphérique de base sont envoyées au périphérique en tant que protocole.
getUpdatedGeneralInfoResult	/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}	GET	Permet de recevoir depuis un périphérique des informations de périphérique modifiées. Cette API peut être exécutée après l’exécution de l’API updateGeneralInfo.
moveDevice	/restapi/v1.0/rms/devices/{deviceId}/move	PUT	Permet de déplacer un périphérique sur un autre groupe.
startRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/start	GET	Permet d’envoyer sur un périphérique un protocole de démarrage RM. Un périphérique ayant reçu un protocole de démarrage RM envoie régulièrement des informations via le serveur de la télécommande.
stopRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop	GET	Permet d’envoyer sur un périphérique un protocole d’arrêt RM. Un périphérique ayant reçu un protocole d’arrêt arrête immédiatement la fonction correspondante.
getSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	GET	Permet d’importer des paramètres relatifs à un périphérique. Les paramètres de périphérique sont actualisés lorsque le périphérique se connecte au serveur.
updateSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	PUT	Permet d’envoyer sur un périphérique des paramètres de périphérique modifiés. Seules les valeurs modifiées dans les paramètres sont envoyées au périphérique en tant que protocole.
getUpdatedSetupInfoResult	/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}	GET	Permet de recevoir depuis un périphérique des paramètres de périphérique modifiés. Cette API peut être exécutée après l’exécution de l’API updateSetupInfo.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display	GET	Permet d’envoyer sur un périphérique une requête d’informations actuelles de contrôle d’affichage. Si vous appelez cette API, vous recevez requestId comme valeur de réponse.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}	GET	Permet d’importer depuis un périphérique des informations de contrôle d’affichage. Cette option est utilisée pour deux actions : envoyer une requête d’informations à un périphérique et recevoir des informations actuelles sur le périphérique.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time	GET	Permet d’envoyer sur un périphérique une requête d’informations actuelles concernant l’heure. Si vous appelez cette API, vous recevez requestId comme valeur de réponse.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}	GET	Permet d’importer des informations sur l’heure envoyées depuis un périphérique. Cette option est utilisée pour deux actions : envoyer une requête d’informations à un périphérique et recevoir des informations actuelles sur le périphérique.
getTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	GET	Permet d’importer des informations sur l’heure du périphérique depuis la base de données. S’il n’y a pas d’informations de contrôle, une requête d’informations doit être envoyée au périphérique.
updateTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	PUT	Permet d’envoyer sur un périphérique des informations modifiées concernant l’heure. Seules les valeurs modifiées dans les informations sur l’heure sont envoyées au périphérique en tant que protocole.
getUpdatedTimeInfoResult	/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}	GET	Permet de recevoir depuis un périphérique des informations modifiées sur l’heure du périphérique. Cette API peut être exécutée après l’exécution de l’API getUpdatedTimeInfoResult.
listDeviceGroupOrgan	/restapi/v1.0/rms/devices/groups	GET	Permet d’importer une liste d’organisations.
listDeviceGroupInfo	/restapi/v1.0/rms/devices/groups/{groupId}	GET	Permet d’importer les détails du groupe {groupId}.
listDeviceGroupChild	/restapi/v1.0/rms/devices/groups/{groupId}/child	GET	Permet d’importer des informations de sous-groupes dans {groupId}.

Utilisateur

Ajoutez des utilisateurs et gérez les informations d’utilisateur. Les services relatifs aux utilisateurs sont accessibles pour les utilisateurs authentifiés possédant les privilèges nécessaires pour lire, écrire et gérer les informations d’utilisateur.

Les services disponibles de gestion d’utilisateur sont comme suit :

Nom du service	Requête API	Type de requête	Description
createUser	/restapi/v1.0/ums/users	POST	Permet d’ajouter un utilisateur.
listDashboardUserInfo	/restapi/v1.0/ums/users/dashboard	GET	Permet d’importer depuis le tableau de bord des informations d’utilisateur indispensables.
updateMyInfo	/restapi/v1.0/ums/users/me	PUT	Permet de modifier les informations relatives à l’utilisateur.
listUserOrgan	/restapi/v1.0/ums/users/organization	GET	Permet d’importer une liste d’organisations. Cette option peut être utilisée pour configurer une arborescence de groupes.
listUserGroupOrgan	/restapi/v1.0/ums/users/groups	GET	Permet d’importer une liste d’organisations.
listUserGroupInfo	/restapi/v1.0/ums/users/groups/{groupId}	GET	Permet d’importer les détails du groupe {groupId}.
listUserGroupChild	/restapi/v1.0/ums/users/groups/{groupId}/child	GET	Permet d’importer une liste de sous-groupes dans le groupe {groupId}.

Réglage

En plus des fonctions principales, vous pouvez utiliser de nombreuses autres fonctions pour créer et gérer des tags et des catégories, et modifier le tableau de bord.

Nom du service	Requête API	Type de requête	Description
getCategoryInfo	/restapi/v1.0/ems/category/{categoryId}	GET	Permet d’importer une liste de catégories.
deleteDashboard	/restapi/v1.0/ems/dashboard	DELETE	Permet de supprimer des informations de tableau de bord spécifiques.
listDashboardInfo	/restapi/v1.0/ems/dashboard	GET	Permet d’importer du contenu à afficher sur le tableau de bord personnalisé. Vous ne pouvez afficher que des informations spécifiques sur le tableau de bord.
updateDashboardPriority	/restapi/v1.0/ems/dashboard	PUT	Permet de changer l’ordre des éléments affichés sur le tableau de bord.
createDashboard	/restapi/v1.0/ems/dashboard/create	GET	Permet d’activer un tableau de bord inactif.
listDashboardLoginInfo	/restapi/v1.0/ems/dashboard/login	GET	Permet d’importer des informations de connexion à afficher sur le tableau de bord.
listDashboardNoticeInfo	/restapi/v1.0/ems/dashboard/notice	GET	Permet d’importer des informations de tableau d’affichage à afficher sur le tableau de bord.
deleteNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	DELETE	Permet de supprimer une publication du tableau d’affichage.
listEditNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	GET	Permet d’importer les détails de la publication sélectionnée.
createNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	POST	Permet d’ajouter des publications au tableau d’affichage.
updateNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	PUT	Permet de modifier la publication sélectionnée sur le tableau d’affichage.
listDashboardStorageInfo	/restapi/v1.0/ems/dashboard/storage	GET	Permet d’importer des informations de stockage à afficher sur le tableau de bord.
listLicense	/restapi/v1.0/ems/license	GET	Permet d’importer une liste de licences enregistrées sur le serveur.
getServerSetupInfo	/restapi/v1.0/ems/setup	GET	Permet d’importer des paramètres relatifs au serveur. Les éléments de réglage du serveur incluent des options qui peuvent activer ou désactiver différentes fonctions sur le serveur.
getTagListInfo	/restapi/v1.0/ems/tag	POST	Permet d’importer une liste de tags enregistrés sur le serveur.

Détails sur Open API (interface utilisateur Swagger)

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

Sv translation

language	pt

O MagicINFO Server permite-lhe implementar funções de gestão do conteúdo, de gestão de agendamentos e de gestão de dispositivos, bem como outras funções, chamando a Open API (v2.0).

Para utilizar a Open API (v2.0), terá de passar primeiro por um processo de autenticação. Utilize uma página swagger separada para testar cada API.

Autenticação

Quando chamar todos os itens da Open API (v2.0), é necessário incluir api_token no cabeçalho. Se o cabeçalho não contiver esta expressão, será devolvido um erro "401 Não Autorizado".

Os tokens obtidos expiram e deixarão de estar disponíveis após um período específico. Se tal acontecer, deve obter um token novo.

Pode chamar a API que se segue para obter api_token.

Nome do serviço	Chamada API	Tipo de chamada	Descrição
authenticationRequest	/auth	POST	Permite importar o valor de um token para efeitos de autenticação através da ID e da palavra-passe de utilizador.
authenticationRequest	/auth/refresh	GET	Permite criar um token novo para adiar a hora da expiração. É possível chamar a API REST sem iniciar sessão novamente.

OPEN API (v2.0)

A Open API (v2.0) do MagicINFO Server disponibiliza várias funções. A configuração de cada função encontra-se apresentada abaixo.

Categoria	Controlador	Descrição
Conteúdo	content-controller	Gestão de ficheiros de conteúdo
Conteúdo	content-group-controller	Gestão de grupos de conteúdo
Lista de reprodução	playlist-controller	Gestão de listas de reprodução
Lista de reprodução	playlist-group-controller	Gestão de grupos de listas de reprodução
Programar	content-schedule-controller	Gestão de agendamentos de conteúdo
	content-schedule-group-controller	Gestão de grupos de agendamentos de conteúdo
	message-schedule-controller	Gestão de agendamentos de mensagens
	message-schedule-group-controller	Gestão de grupos de agendamentos de mensagens
Dispositivo	device-controller	Gestão de dispositivos
Dispositivo	device-group-controller	Gestão de grupos de dispositivos
Utilizador	user-controller	Gestão de utilizadores
Utilizador	user-group-controller	Gestão de grupos de utilizadores
Definição	environment-controller	Definição

Conteúdo

Pode carregar, aprovar e eliminar conteúdo. Também pode fazer a gestão de listas de conteúdo. Os serviços relativos a conteúdo estão acessíveis a utilizadores autenticados com privilégios de leitura, escrita e gestão de conteúdo.

Os serviços de gestão do conteúdo disponíveis são os seguintes:

Nome do serviço	Chamada API	Tipo de chamada	Descrição
listAllContent	/restapi/v1.0/cms/contents	GET	Permite importar uma lista de conteúdo carregado. A lista inclui miniaturas, nomes, tipos de ficheiro e outras informações básicas sobre o conteúdo. É possível importar as listas por página através das informações de paginação.
listDashboardContentInfo	/restapi/v1.0/cms/contents/dashboard	GET	Permite importar informações gerais sobre o conteúdo que será apresentado no painel de controlo.
listContent	/restapi/v1.0/cms/contents/filter	POST	Permite importar uma lista de conteúdo filtrado com base em condições. É possível importar as listas por página através das informações de paginação.
forceDeleteContent	/restapi/v1.0/cms/contents/force/{contentId}	DELETE	Permite eliminar conteúdo, quer o conteúdo esteja incluído numa lista de reprodução ou num agendamento ou não.
deleteContent	/restapi/v1.0/cms/contents/{contentId}	DELETE	Permite eliminar conteúdo após se verificar que o conteúdo não está incluído numa lista de reprodução nem num agendamento. Se tentar eliminar conteúdo incluído numa lista de reprodução ou agendamento, este não será eliminado. Além disso, será devolvido um código de erro.
getActiveContentInfo	/restapi/v1.0/cms/contents/{contentId}	GET	Permite importar detalhes sobre uma versão ativada de conteúdo. A versão do conteúdo é atualizada sempre que o conteúdo é editado.
approveContents	/restapi/v1.0/cms/contents/{contentId}/approval	PUT	Permite aprovar/rejeitar conteúdo. O conteúdo aprovado é movido para a lista de conteúdo geral e pode ser utilizado em listas de reprodução ou agendamentos.
uploadContent	/restapi/v1.0/cms/contents/{groupId}	POST	Permite carregar conteúdo novo.
listDefaultGroup	/restapi/v1.0/cms/contents/groups	GET	Permite importar uma lista de grupos de conteúdo predefinido.
getGroup	/restapi/v1.0/cms/contents/groups/{groupId}	GET	Permite importar detalhes do grupo {groupId}.
listChildGroup	/restapi/v1.0/cms/contents/groups/{groupId}/child	GET	Permite importar uma lista de subgrupos do grupo {groupId}.

Lista de reprodução

Pode utilizar conteúdo para criar, editar ou eliminar listas de reprodução. Os serviços relativos a listas de reprodução estão acessíveis a utilizadores autenticados com privilégios de leitura, escrita e gestão de conteúdo.

Os serviços de gestão de listas de reprodução disponíveis são os seguintes:

Nome do serviço	Chamada API	Tipo de chamada	Descrição
listAllPlaylist	/restapi/v1.0/cms/playlists	GET	Permite importar uma lista de todas as listas de reprodução. A lista inclui nomes de listas de reprodução, miniaturas do conteúdo principal, tipos de listas de reprodução e outras informações básicas. É possível importar as listas por página através das informações de paginação.
createPlaylist	/restapi/v1.0/cms/playlists	POST	Permite criar uma nova lista de reprodução.
getDashboardPlaylistInfo	/restapi/v1.0/cms/playlists/dashboard	GET	Permite importar informações necessárias sobre a lista de reprodução a partir do painel de controlo.
listPlaylist	/restapi/v1.0/cms/playlists/filter	POST	Permite importar uma lista de listas de reprodução filtradas com base em condições. É possível importar as listas por página através das informações de paginação.
deletePlaylist	/restapi/v1.0/cms/playlists/{playlistId}	DELETE	Permite eliminar a lista de reprodução selecionada. Se tentar eliminar uma lista de reprodução incluída num agendamento, esta não será eliminada. Além disso, será devolvido um código de erro.
getActivePlaylistInfo	/restapi/v1.0/cms/playlists/{playlistId}	GET	Permite importar detalhes sobre uma versão ativada de uma lista de reprodução. A versão da lista de reprodução é atualizada sempre que a lista de reprodução é editada.
editPlaylist	/restapi/v1.0/cms/playlists/{playlistId}	PUT	Permite editar a lista de reprodução {playlistId}. A edição de uma lista de reprodução atualiza a respetiva versão e faz com que o dispositivo que reproduz a lista de reprodução reproduza automaticamente a lista de reprodução atualizada.
copyPlaylist	/restapi/v1.0/cms/playlists/{playlistId}/copy	PUT	Permite copiar a lista de reprodução {playlistId}. É criada uma cópia duplicada da lista de reprodução.
listDefaultGroup	/restapi/v1.0/cms/playlists/groups	GET	Permite importar uma lista de grupos de listas de reprodução predefinidas.
getGroup	/restapi/v1.0/cms/playlists/groups/{groupId}	GET	Permite importar detalhes do grupo {groupId}.
listChildGroup	/restapi/v1.0/cms/playlists/groups/{groupId}/child	GET	Permite importar uma lista de subgrupos do grupo {groupId}.

Programar

Pode criar conteúdo ou agendamentos de mensagens novos. Também pode publicar agendamentos em dispositivos para reprodução, bem como editar ou eliminar agendamentos.

Os serviços relativos a agendamentos estão acessíveis a utilizadores autenticados com privilégios de leitura, escrita e gestão de agendamentos.

Os serviços de gestão de agendamentos disponíveis são os seguintes:

Nome do serviço	Chamada API	Tipo de chamada	Descrição
listContentScheduleAll	/restapi/v1.0/dms/schedule/contents	GET	Permite importar uma lista de todos os agendamentos de conteúdo. A lista inclui nomes de agendamentos de conteúdo, datas de criação, tipos de dispositivo e outras informações básicas. É possível importar as listas por página através das informações de paginação.
createContentSchedule	/restapi/v1.0/dms/schedule/contents	POST	Permite criar um novo agendamento de conteúdo. Um agendamento de conteúdo poderá conter vários canais e fotogramas. Permite publicar um agendamento em dispositivos e reproduzir o conteúdo ou a lista de reprodução pretendido a uma determinada hora.
listDashboardScheduleInfo	/restapi/v1.0/dms/schedule/contents/dashboard	GET	Permite importar informações necessárias sobre o agendamento de conteúdo a partir do painel de controlo.
listContentScheduleByGroup	/restapi/v1.0/dms/schedule/contents/filter	POST	Permite importar uma lista de agendamentos de conteúdo filtrados com base em diferentes condições. É possível importar as listas por página através das informações de paginação.
deleteContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	DELETE	Permite eliminar um agendamento de conteúdo. Se eliminar um agendamento previamente publicado num dispositivo, este último reproduz automaticamente o conteúdo predefinido.
getProgramInfo	/restapi/v1.0/dms/schedule/contents/{programId}	GET	Permite importar detalhes do agendamento selecionado.
editContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	PUT	Permite editar um agendamento de conteúdo. Se editar um agendamento previamente publicado num dispositivo, este último reproduz automaticamente o agendamento editado.
copyContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/copy	PUT	Permite copiar o agendamento de conteúdo {programId}. É criada uma cópia duplicada do agendamento de conteúdo {programId}.
deployContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/deploy	PUT	Permite publicar um agendamento de conteúdo num grupo de dispositivos específico.
getPublishStatus	/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus	GET	Permite importar o estado de transferência de agendamentos de conteúdo em tempo real a partir de um dispositivo.
getRootGroups	/restapi/v1.0/dms/schedule/contents/groups	GET	Permite importar uma lista de grupos de raiz para um agendamento de conteúdo.
listContentScheduleGroupInfo	/restapi/v1.0/dms/schedule/contents/groups/{groupId}	GET	Permite importar detalhes do grupo {groupId}.
listAllMessageSchedule	/restapi/v1.0/dms/schedule/messages	GET	Permite importar uma lista de todos os agendamentos de mensagens.
createMessageSchedule	/restapi/v1.0/dms/schedule/messages	POST	Permite criar um novo agendamento de mensagens.
listMessage	/restapi/v1.0/dms/schedule/messages/filter	POST	Permite importar uma lista de agendamentos de mensagens filtrados com base em diferentes condições. É possível importar as listas por página através das informações de paginação.
deleteMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	DELETE	Permite eliminar o agendamento de mensagens selecionado. Se eliminar um agendamento de mensagens previamente publicado num dispositivo, a alteração é automaticamente aplicada no dispositivo.
getMessageInfo	/restapi/v1.0/dms/schedule/messages/{messageId}	GET	Permite importar detalhes do agendamento de mensagens selecionado.
editMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	PUT	Permite editar o agendamento de mensagens selecionado. Se editar um agendamento de mensagens previamente publicado num dispositivo, a alteração é automaticamente aplicada no dispositivo.
copyMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/copy	PUT	Permite copiar o agendamento de mensagens selecionado. É criada uma cópia duplicada do agendamento de mensagens.
deployMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/deploy	PUT	Permite publicar o agendamento de mensagens selecionado num grupo de dispositivos.
getRootGroups	/restapi/v1.0/dms/schedule/messages/groups	GET	Permite importar uma lista de grupos de raiz para um agendamento de conteúdo.
listMessageScheduleGroupInfo	/restapi/v1.0/dms/schedule/messages/groups/{groupId}	GET	Permite importar detalhes do grupo {groupId}.
getChildGroups	/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child	GET	Permite importar uma lista de subgrupos de um grupo específico.

Dispositivo

Pode controlar e gerir dispositivos. Os serviços relativos a dispositivos estão acessíveis a utilizadores autenticados com privilégios de leitura, escrita e gestão de dispositivos.

Os serviços de gestão de dispositivos disponíveis são os seguintes:

Nome do serviço	Chamada API	Tipo de chamada	Descrição
listAllDevice	/restapi/v1.0/rms/devices	GET	Permite importar uma lista de todos os dispositivos. A lista inclui o estado da energia do dispositivo, informações sobre as miniaturas, o estado de erro do dispositivo e outras informações básicas. É possível importar as listas por página através das informações de paginação.
getDashboardDeviceInfo	/restapi/v1.0/rms/devices/dashboard	GET	Permite importar informações necessárias sobre o dispositivo a partir do painel de controlo.
filterDeviceList	/restapi/v1.0/rms/devices/filter	POST	Permite importar uma lista de dispositivos filtrados com base em diferentes condições. É possível importar as listas por página através das informações de paginação.
deleteDevice	/restapi/v1.0/rms/devices/{deviceId}	DELETE	Permite eliminar o dispositivo selecionado.
getDevice	/restapi/v1.0/rms/devices/{deviceId}	GET	Permite importar detalhes do dispositivo selecionado.
approveDevice	/restapi/v1.0/rms/devices/{deviceId}/approval	PUT	Permite aprovar o dispositivo selecionado para um grupo específico.
getCabinetList	/restapi/v1.0/rms/devices/{deviceId}/cabinet	POST	Permite importar informações sobre cabinets ligados a um dispositivo LED. As informações importadas só são válidas quando os cabinets estão ligados a um dispositivo LED.
updateCabinetInfo	/restapi/v1.0/rms/devices/{deviceId}/cabinet	PUT	Permite editar informações sobre cabinets ligados a um dispositivo LED.
getDisplayControlInfo	/restapi/v1.0/rms/devices/{deviceId}/display	GET	Permite importar informações de controlo de apresentação de dispositivos a partir da base de dados. Se não existirem informações de apresentação, deve enviar-se um pedido de informações para o dispositivo.
updateDisplayInfo	/restapi/v1.0/rms/devices/{deviceId}/display	PUT	Permite enviar informações de controlo de apresentação editadas para um dispositivo. Só os valores editados que se encontram nas informações de apresentação são enviados sob a forma de protocolo para o dispositivo.
getUpdatedDisplayInfoResult	/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}	GET	Permite receber informações de controlo de apresentação editadas de um dispositivo. Esta API é executável após a execução da API updateDisplayInfo.
getGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general	GET	Permite importar informações gerais de dispositivos a partir da base de dados. As informações gerais do dispositivo são atualizadas quando este se liga ao servidor.
updateGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general/info	PUT	Permite enviar informações de dispositivos editadas para um dispositivo. Só os valores editados que se encontram nas informações básicas de dispositivos são enviados sob a forma de protocolo para o dispositivo.
getUpdatedGeneralInfoResult	/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}	GET	Permite receber informações de dispositivos a partir de um dispositivo. Esta API é executável após a execução da API updateGeneralInfo.
moveDevice	/restapi/v1.0/rms/devices/{deviceId}/move	PUT	Permite mover um dispositivo para outro grupo.
startRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/start	GET	Permite enviar um protocolo de início RM para um dispositivo. Os dispositivos que receberam um protocolo de início RM enviam periodicamente informações através do Servidor do Controlo Remoto.
stopRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop	GET	Permite enviar um protocolo de paragem RM para um dispositivo. Os dispositivos que receberam um protocolo de paragem param imediatamente a função correspondente.
getSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	GET	Permite importar definições de dispositivos. As definições do dispositivo são atualizadas quando este se liga ao servidor.
updateSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	PUT	Permite enviar definições de dispositivos editadas para um dispositivo. Só os valores editados que se encontram nas definições são enviados sob a forma de protocolo para o dispositivo.
getUpdatedSetupInfoResult	/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}	GET	Permite receber definições de dispositivos a partir de um dispositivo. Esta API é executável após a execução da API updateSetupInfo.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display	GET	Permite enviar um pedido atual de informações de controlo de apresentação para um dispositivo. Se se chamar esta API, requestId é devolvido como o valor de resposta.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}	GET	Permite importar informações de controlo de apresentação enviadas a partir de um dispositivo. Esta opção é utilizada para duas ações: envio de um pedido de informações para um dispositivo e receção de informações reais do dispositivo.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time	GET	Permite enviar um pedido atual de informações de hora para um dispositivo. Se se chamar esta API, requestId é devolvido como o valor de resposta.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}	GET	Permite importar informações de hora enviadas a partir de um dispositivo. Esta opção é utilizada para duas ações: envio de um pedido de informações para um dispositivo e receção de informações reais do dispositivo.
getTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	GET	Permite importar informações de hora de dispositivos a partir da base de dados. Se não existirem informações de apresentação, deve enviar-se um pedido de informações para o dispositivo.
updateTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	PUT	Permite enviar informações de hora editadas para um dispositivo. Só os valores editados que se encontram nas informações de hora são enviados sob a forma de protocolo para o dispositivo.
getUpdatedTimeInfoResult	/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}	GET	Permite receber informações de hora de dispositivos a partir de um dispositivo. Esta API é executável após a execução da API getUpdatedTimeInfoResult.
listDeviceGroupOrgan	/restapi/v1.0/rms/devices/groups	GET	Permite importar uma lista de organizações.
listDeviceGroupInfo	/restapi/v1.0/rms/devices/groups/{groupId}	GET	Permite importar detalhes do grupo {groupId}.
listDeviceGroupChild	/restapi/v1.0/rms/devices/groups/{groupId}/child	GET	Permite importar informações sobre subgrupos de {groupId}.

Utilizador

Pode adicionar utilizadores e gerir informações dos mesmos. Os serviços relativos a utilizadores estão acessíveis a utilizadores autenticados com privilégios de leitura, escrita e gestão de informações de utilizadores.

Os serviços de gestão de utilizadores disponíveis são os seguintes:

Nome do serviço	Chamada API	Tipo de chamada	Descrição
createUser	/restapi/v1.0/ums/users	POST	Permite adicionar um utilizador.
listDashboardUserInfo	/restapi/v1.0/ums/users/dashboard	GET	Permite importar informações necessárias sobre utilizadores a partir do painel de controlo.
updateMyInfo	/restapi/v1.0/ums/users/me	PUT	Permite editar informações de utilizadores.
listUserOrgan	/restapi/v1.0/ums/users/organization	GET	Permite importar uma lista de organizações. Esta opção pode ser utilizada para configurar a árvore de um grupo.
listUserGroupOrgan	/restapi/v1.0/ums/users/groups	GET	Permite importar uma lista de organizações.
listUserGroupInfo	/restapi/v1.0/ums/users/groups/{groupId}	GET	Permite importar detalhes do grupo {groupId}.
listUserGroupChild	/restapi/v1.0/ums/users/groups/{groupId}/child	GET	Permite importar uma lista de subgrupos do grupo {groupId}.

Definição

Para além das funções principais, pode utilizar muitas outras funções para criar e gerir identificadores e categorias, bem como para editar o painel de controlo.

Nome do serviço	Chamada API	Tipo de chamada	Descrição
getCategoryInfo	/restapi/v1.0/ems/category/{categoryId}	GET	Permite importar uma lista de categorias.
deleteDashboard	/restapi/v1.0/ems/dashboard	DELETE	Permite eliminar informações de painel de controlo específicas.
listDashboardInfo	/restapi/v1.0/ems/dashboard	GET	Permite importar conteúdo que será apresentado no painel de controlo personalizado. Só é possível apresentar informações específicas no painel de controlo.
updateDashboardPriority	/restapi/v1.0/ems/dashboard	PUT	Permite alterar a ordem dos itens apresentados no painel de controlo.
createDashboard	/restapi/v1.0/ems/dashboard/create	GET	Permite ativar um painel de controlo inativo.
listDashboardLoginInfo	/restapi/v1.0/ems/dashboard/login	GET	Permite importar informações de início de sessão que serão apresentadas no painel de controlo.
listDashboardNoticeInfo	/restapi/v1.0/ems/dashboard/notice	GET	Permite importar informações de quadro de avisos que serão apresentadas no painel de controlo.
deleteNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	DELETE	Permite eliminar uma publicação de um quadro de avisos.
listEditNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	GET	Permite importar detalhes da publicação selecionada.
createNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	POST	Permite adicionar publicações ao quadro de avisos.
updateNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	PUT	Permite editar a publicação selecionada no quadro de avisos.
listDashboardStorageInfo	/restapi/v1.0/ems/dashboard/storage	GET	Permite importar informações de armazenamento que serão apresentadas no painel de controlo.
listLicense	/restapi/v1.0/ems/license	GET	Permite importar uma lista de licenças registadas no servidor.
getServerSetupInfo	/restapi/v1.0/ems/setup	GET	Permite importar definições do servidor. Os itens das definições do servidor incluem opções que podem ativar ou desativar as diferentes funções no servidor.
getTagListInfo	/restapi/v1.0/ems/tag	POST	Permite importar uma lista de identificadores registados no servidor.

Detalhes da Open API (IU swagger)

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

Sv translation

language	ru

MagicINFO Server позволяет реализовать управление содержимым, расписаниями, устройствами, а также другие функции с помощью вызова методов Open API (v2.0).

Для того, чтобы использовать Open API (v2.0), сперва нужно пройти процедуру аутентификации. Используйте отдельную swagger-страницу для проверки каждого API.

Проверка подлинности

При вызове объектов Open API (v2.0) необходимо включить в заголовок api_token. В противном случае появится ошибка "401 Нет доступа".

Маркер доступа становится недоступным для использования по истечении срока действия. В этом случае необходимо получить новый маркер доступа.

Получить маркер доступа api_token можно путем вызова следующего api.

Название услуги	Вызов API	Тип вызова	Описание
Запрос «Аутентификация»	/auth	POST (создание)	Импорт значения маркера доступа для аутентификации с использованием ИД и пароля пользователя.
Запрос «Аутентификация»	/auth/refresh	GET (чтение)	Создание нового маркера доступа для продления срока действия. Вызов REST API можно осуществлять без повторного входа в систему.

OPEN API (v2.0)

MagicINFO Server Open API (v2.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 (создание)	Импорт сведений о блоках, подключенных к светодиодному устройству. Полученные сведения действительны только при условии подключения блоков к светодиодному устройству.
updateCabinetInfo	/restapi/v1.0/rms/devices/{deviceId}/cabinet	PUT (заполнение)	Изменение сведений о блоках, подключенных к светодиодному устройству.
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 запрос отображается в виде ответного значения.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}	GET (чтение)	Импорт информации об управлении экраном, отправленной с устройства. Эта опция используется для выполнения двух действий: отправка запроса информации на устройство и получение информации о нем.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time	GET (чтение)	Отправка запроса информации о текущем времени на устройство. При вызове этого API запрос отображается в виде ответного значения.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}	GET (чтение)	Импорт информации о времени экраном, отправленной с устройства. Эта опция используется для выполнения двух действий: отправка запроса информации на устройство и получение информации о нем.
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 (создание)	Импорт списка меток, зарегистрированных на сервере.

Открытие подробных сведений API (swagger UI)

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 未授权”错误。

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

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

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

OPEN API（2.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 将作为响应值返回。
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}	GET	导入从设备发送的显示屏控制信息。此选项用于两个操作：将信息请求发送到设备和接收实际设备信息。
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time	GET	将当前时间信息请求发送到设备。如果调用此 API，requestId 将作为响应值返回。
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}	GET	导入从设备发送的时间信息。此选项用于两个操作：将信息请求发送到设备和接收实际设备信息。
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

Sv translation

language	tr

MagicINFO Server, Open API’ye (v2.0) çağrı yaparak içerik yönetimi, zamanlama yönetimi, aygıt yönetimi ve diğer işlevleri gerçekleştirmenize olanak sağlar.

Open API’yi (v2.0) kullanmak için önce bir kimlik denetimi sürecini tamamlamanız gerekir. API’leri test ederken her bir API için farklı bir swagger sayfası kullanın.

Kimlik denetimi

Open API (v2.0) öğelerine çağrı yapılırken api_token değerinin başlık bölümüne eklenmesi gerekir. Eklenmezse “401 Unauthorized” hatası döndürülür.

Belirlenen zaman diliminden sonra, alınan belirtecin tarihi geçer ve kullanılamaz hale gelir. Bu durumda yeni bir belirteç almanız gerekir.

api_token değeri aşağıdaki API’ye yapılacak bir çağrı aracılığıyla edinilebilir.

Hizmet Adı	API çağrısı	Çağrı Türü	Açıklama
authenticationRequest	/auth	POST	Kullanıcı kimliği ve parolasını kullanarak kimlik denetimi için bir belirteç değeri içeri aktarır.
authenticationRequest	/auth/refresh	GET	Geçerlilik süresini uzatmak için yeni bir belirteç oluşturur. Tekrar oturum açmadan REST API’ye çağrı yapılabilir

OPEN API (v2.0)

MagicINFO Server Open API (v2.0) çeşitli işlevler sunar. Her bir işleve yönelik yapılandırma aşağıda gösterilmiştir.

Kategori	Denetleyici	Açıklama
İçerik	content-controller	İçerik dosyası yönetimi
İçerik	content-group-controller	İçerik grubu yönetimi
Oynatma listesi	playlist-controller	Bir çalma listesinin yönetilmesi
Oynatma listesi	playlist-group-controller	Çalma listesi grubu yönetimi
Zamanlama	content-schedule-controller	İçerik zamanlaması yönetimi
	content-schedule-group-controller	İçerik zamanlaması grubu yönetimi
	message-schedule-controller	Mesaj zamanlaması yönetimi
	message-schedule-group-controller	Mesaj zamanlaması grubu yönetimi
Aygıt	device-controller	Aygıt yönetimi
Aygıt	device-group-controller	Aygıt grubu yönetimi
Kullanıcı	user-controller	Kullanıcı yönetimi
Kullanıcı	user-group-controller	Kullanıcı grubu yönetimi
Ayar	environment-controller	Ayar

İçerik

İçerik yükleyin, onaylayın ya da silin. İçerik listelerini yönetin. İçerikle ilgili hizmetlere içerik okuma, yazma ve yönetme izni olan doğrulanmış kullanıcıların erişimi vardır.

Kullanılabilen içerik yönetimi hizmetleri şunlardır:

Hizmet Adı	API çağrısı	Çağrı Türü	Açıklama
listAllContent	/restapi/v1.0/cms/contents	GET	Karşıya yüklenmiş dosyaların listesini içeri aktarır. Listede içerik küçük resimleri, isimler, dosya türleri ve diğer temel bilgiler bulunur. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
listDashboardContentInfo	/restapi/v1.0/cms/contents/dashboard	GET	Kontrol panelinde gösterilecek genel içerik bilgilerini içeri aktarır.
listContent	/restapi/v1.0/cms/contents/filter	POST	Koşula göre filtrelenmiş bir içerik listesini içeri aktarır. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
forceDeleteContent	/restapi/v1.0/cms/contents/force/{contentId}	DELETE	İçeriğin bir çalma listesine ya da zamanlamaya dahil edilmiş olup olmaması fark etmeksizin içeriği siler.
deleteContent	/restapi/v1.0/cms/contents/{contentId}	DELETE	İçeriğin bir çalma listesine ya da zamanlamaya dahil edilmemiş olduğunu onayladıktan sonra içeriği siler. Bir çalma listesine veya zamanlamaya dahil edilmiş bir içerik silinmeye çalışılıyorsa içerik silinmez ve bir hata kodu döndürülür.
getActiveContentInfo	/restapi/v1.0/cms/contents/{contentId}	GET	İçeriğin aktifleştirilmiş bir sürümünün detaylarını içeri aktarır. İçerik her düzenlendiğinde sürümü güncellenir.
approveContents	/restapi/v1.0/cms/contents/{contentId}/approval	PUT	İçeriği onaylar veya reddeder. Onaylanan içerik genel içerik listesine aktarılır ve çalma listelerinde veya zamanlamalarda kullanılabilir.
uploadContent	/restapi/v1.0/cms/contents/{groupId}	POST	Yeni içeriği karşıya yükler.
listDefaultGroup	/restapi/v1.0/cms/contents/groups	GET	Varsayılan içerik gruplarının listesini içeri aktarır.
getGroup	/restapi/v1.0/cms/contents/groups/{groupId}	GET	{groupId} grubunun detaylarını içeri aktarır.
listChildGroup	/restapi/v1.0/cms/contents/groups/{groupId}/child	GET	{groupId} grubunun altındaki alt grupların listesini içeri aktarır.

Oynatma listesi

İçeriği kullanarak çalma listeleri oluşturun, düzenleyin veya silin. Çalma listesiyle ilgili hizmetlere içerik okuma, yazma ve yönetme izni olan doğrulanmış kullanıcıların erişimi vardır.

Kullanılabilir çalma listesi yönetimi hizmetleri şunlardır:

Hizmet Adı	API çağrısı	Çağrı Türü	Açıklama
listAllPlaylist	/restapi/v1.0/cms/playlists	GET	Tüm çalma listelerinin listesini içeri aktarır. Listede çalma listesi isimleri, ana içeriğin küçük resimleri, çalma listesi türleri ve diğer temel bilgiler bulunur. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
createPlaylist	/restapi/v1.0/cms/playlists	POST	Yeni bir çalma listesi oluşturur.
getDashboardPlaylistInfo	/restapi/v1.0/cms/playlists/dashboard	GET	Kontrol panelinden gerekli çalma listesi bilgilerini içeri aktarır.
listPlaylist	/restapi/v1.0/cms/playlists/filter	POST	Koşula göre filtrelenmiş çalma listelerinin bir listesini içeri aktarır. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
deletePlaylist	/restapi/v1.0/cms/playlists/{playlistId}	DELETE	Seçilen çalma listesini siler. Bir zamanlamaya dahil edilmiş bir çalma listesi silinmeye çalışılıyorsa çalma listesi silinmez ve bir hata kodu döndürülür.
getActivePlaylistInfo	/restapi/v1.0/cms/playlists/{playlistId}	GET	Çalma listesinin aktifleştirilmiş bir sürümünün detaylarını içeri aktarır. Çalma listesi her düzenlendiğinde sürümü güncellenir.
editPlaylist	/restapi/v1.0/cms/playlists/{playlistId}	PUT	{playlistId} çalma listesini düzenler. Bir çalma listesi düzenlenlendiğinde çalma listesi sürümü güncellenir ve çalma listesini oynatan aygıt, güncellenmiş çalma listesini otomatik olarak oynatır.
copyPlaylist	/restapi/v1.0/cms/playlists/{playlistId}/copy	PUT	{playlistId} çalma listesini kopyalar. Çalma listesinin bir kopyası oluşturulur.
listDefaultGroup	/restapi/v1.0/cms/playlists/groups	GET	Varsayılan çalma listesi gruplarının bir listesini içeri aktarır.
getGroup	/restapi/v1.0/cms/playlists/groups/{groupId}	GET	{groupId} grubunun detaylarını içeri aktarır.
listChildGroup	/restapi/v1.0/cms/playlists/groups/{groupId}/child	GET	{groupId} grubunun altındaki alt grupların listesini içeri aktarır.

Zamanlama

Yeni içerik ya da mesaj zamanlamaları oluşturun. Zamanlamaları oynatma için aygıtlara yayınlayın. Zamanlamaları düzenleyin veya silin.

Zamanlama ile ilgili hizmetlere zamanlamaları okuma, yazma ve yönetme izni olan doğrulanmış kullanıcıların erişimi vardır.

Kullanılabilir zamanlama yönetimi hizmetleri şunlardır:

Hizmet Adı	API çağrısı	Çağrı Türü	Açıklama
listContentScheduleAll	/restapi/v1.0/dms/schedule/contents	GET	İçerik zamanlamalarının listesini içeri aktarır. Listede içerik zamanlamalarının isimleri, oluşturulma tarihleri, aygıt türleri ve diğer temel bilgiler bulunur. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
createContentSchedule	/restapi/v1.0/dms/schedule/contents	POST	Yeni bir içerik zamanlaması oluşturur. İçerik zamanlamaları birden fazla kanal ve çerçeve içerebilir. Aygıtlara bir zamanlama yayınlayıp arzu edilen içerik ya da çalma listesini belirlenen zamanda oynatın.
listDashboardScheduleInfo	/restapi/v1.0/dms/schedule/contents/dashboard	GET	Kontrol panelinden gerekli içerik zamanlama bilgilerini içeri aktarır.
listContentScheduleByGroup	/restapi/v1.0/dms/schedule/contents/filter	POST	Farklı koşullara göre filtrelenmiş bir içerik zamanlaması listesini içeri aktarır. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
deleteContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	DELETE	İçerik zamanlamasını siler. Daha önce bir aygıta yayınlanmış bir zamanlama siliniyorsa aygıt otomatik olarak varsayılan içeriği oynatır.
getProgramInfo	/restapi/v1.0/dms/schedule/contents/{programId}	GET	Seçilen grubun detaylarını içeri aktarır.
editContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	PUT	İçerik zamanlamasını düzenler. Daha önce bir aygıta yayınlanmış bir zamanlama düzenleniyorsa aygıt otomatik olarak düzenlenmiş içeriği oynatır.
copyContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/copy	PUT	{programId} içerik zamanlamasını kopyalar. {programId} içerik zamanlamasının bir kopyası oluşturulur.
deployContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/deploy	PUT	İçerik zamanlamasını belirli bir aygıt grubuna yayınlar.
getPublishStatus	/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus	GET	Gerçek zamanlı içerik zamanlaması indirme durumunu bir aygıttan içeri aktarır.
getRootGroups	/restapi/v1.0/dms/schedule/contents/groups	GET	İçerik zamanlaması için kök grupların listesini içeri aktarır.
listContentScheduleGroupInfo	/restapi/v1.0/dms/schedule/contents/groups/{groupId}	GET	{groupId} grubunun detaylarını içeri aktarır.
listAllMessageSchedule	/restapi/v1.0/dms/schedule/messages	GET	Tüm mesaj zamanlamalarının listesini içeri aktarır.
createMessageSchedule	/restapi/v1.0/dms/schedule/messages	POST	Yeni bir mesaj programı oluşturur.
listMessage	/restapi/v1.0/dms/schedule/messages/filter	POST	Farklı koşullara göre filtrelenmiş bir mesaj zamanlaması listesini içeri aktarır. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
deleteMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	DELETE	Seçilen mesaj zamanlamasını siler. Daha önce bir aygıta yayınlanmış bir mesaj zamanlaması siliniyorsa değişiklik otomatik olarak aygıta uygulanır.
getMessageInfo	/restapi/v1.0/dms/schedule/messages/{messageId}	GET	Seçilen mesaj zamanlamasının detaylarını içeri aktarır.
editMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	PUT	Seçilen mesaj zamanlamasını düzenler. Daha önce bir aygıta yayınlanmış bir mesaj zamanlaması düzenleniyorsa değişiklik otomatik olarak aygıta uygulanır.
copyMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/copy	PUT	Seçilen mesaj zamanlamasını kopyalar. Mesaj zamanlamasının bir kopyası oluşturulur.
deployMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/deploy	PUT	Seçilen mesaj zamanlamasını bir aygıt grubuna yayınlar.
getRootGroups	/restapi/v1.0/dms/schedule/messages/groups	GET	İçerik zamanlaması için kök grupların listesini içeri aktarır.
listMessageScheduleGroupInfo	/restapi/v1.0/dms/schedule/messages/groups/{groupId}	GET	{groupId} grubunun detaylarını içeri aktarır.
getChildGroups	/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child	GET	Belirli bir grubun altındaki alt grupların listesini içeri aktarır.

Aygıt

Aygıtları kontrol edin ve yönetin. Aygıtlarla ilgili hizmetlere aygıtları okuma, yazma ve yönetme izni olan doğrulanmış kullanıcıların erişimi vardır.

Mevcut aygıt yönetimi hizmetleri şunlardır:

Hizmet Adı	API çağrısı	Çağrı Türü	Açıklama
listAllDevice	/restapi/v1.0/rms/devices	GET	Tüm aygıtların listesini içeri aktarır. Listede aygıt güç durumları, küçük resim bilgisi, aygıt hata durumları ve diğer temel bilgiler bulunur. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
getDashboardDeviceInfo	/restapi/v1.0/rms/devices/dashboard	GET	Kontrol panelinden gerekli aygıt bilgilerini içeri aktarır.
filterDeviceList	/restapi/v1.0/rms/devices/filter	POST	Farklı koşullara göre filtrelenmiş bir aygıt listesini içeri aktarır. Listeler, sayfa numaralandırma bilgileri kullanılarak sayfa sayfa içeri aktarılabilir.
deleteDevice	/restapi/v1.0/rms/devices/{deviceId}	DELETE	Seçilen aygıtı siler.
getDevice	/restapi/v1.0/rms/devices/{deviceId}	GET	Seçilen aygıtın detaylarını içeri aktarır.
approveDevice	/restapi/v1.0/rms/devices/{deviceId}/approval	PUT	Seçilen aygıtı belirli bir grup için onaylar.
getCabinetList	/restapi/v1.0/rms/devices/{deviceId}/cabinet	POST	LED aygıtına bağlanmış cabinet'ler hakkındaki bilgileri içeri aktarır. İçeri aktarılan bilgiler sadece cabinet'ler bir LED aygıtına bağlı olduğu zaman geçerlidir.
updateCabinetInfo	/restapi/v1.0/rms/devices/{deviceId}/cabinet	PUT	LED aygıtına bağlanmış cabinet'ler hakkındaki bilgileri düzenler.
getDisplayControlInfo	/restapi/v1.0/rms/devices/{deviceId}/display	GET	Veri tabanından aygıt ekran kontrol bilgilerini içeri aktarır. Kontrol bilgisi yoksa aygıta bir bilgi isteği gönderilmelidir.
updateDisplayInfo	/restapi/v1.0/rms/devices/{deviceId}/display	PUT	Düzenlenmiş ekran kontrol bilgilerini bir aygıta gönderir. Aygıta sadece ekran bilgisindeki düzenlenmiş değerler protokol olarak gönderilir.
getUpdatedDisplayInfoResult	/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}	GET	Aygıttan düzenlenmiş ekran kontrol bilgilerini alır. Bu API, updateDisplayInfo API’si yürütüldükten sonra yürütülebilir.
getGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general	GET	Veri tabanından genel aygıt bilgilerini içeri aktarır. Genel aygıt bilgisi, aygıt sunucuya bağlandığında güncellenir.
updateGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general/info	PUT	Düzenlenmiş aygıt bilgilerini bir aygıta gönderir. Aygıta sadece temel aygıt bilgisindeki düzenlenmiş değerler protokol olarak gönderilir.
getUpdatedGeneralInfoResult	/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}	GET	Aygıttan düzenlenmiş aygıt bilgilerini alır. Bu API, updateGeneralInfo API’si yürütüldükten sonra yürütülebilir.
moveDevice	/restapi/v1.0/rms/devices/{deviceId}/move	PUT	Aygıtı farklı bir gruba taşır.
startRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/start	GET	Aygıta bir RM başlatma protokolü gönderir. RM başlatma protokolü alan bir aygıt, Uzaktan Kumanda Sunucusu aracılığıyla düzenli aralıklarla bilgi gönderir.
stopRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop	GET	RM durdurma protokolünü bir aygıta gönderir. RM durdurma protokolü alan bir aygıt ilgili işlevi anında durdurur.
getSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	GET	Aygıt ayarlarını içeri aktarır. Aygıt ayarları, aygıt sunucuya bağlandığında güncellenir.
updateSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	PUT	Düzenlenmiş aygıt ayarlarını bir aygıta gönderir. Aygıta sadece ayarlardaki düzenlenmiş değerler protokol olarak gönderilir.
getUpdatedSetupInfoResult	/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}	GET	Aygıttan düzenlenmiş aygıt ayarlarını alır. Bu API, updateSetupInfo API’si yürütüldükten sonra yürütülebilir.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display	GET	Aygıta mevcut ekran kontrol bilgileri için bir istek gönderir. Bu API çağırılırsa requestId cevap değeri olarak döndürülür.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}	GET	Aygıttan gönderilen ekran kontrol bilgisini içeri aktarır. Bu seçenek iki eylem için kullanılır: aygıta bilgi isteği göndermek ve asıl aygıt bilgisini almak.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time	GET	Aygıta mevcut zaman bilgisi için bir istek gönderir. Bu API çağırılırsa requestId cevap değeri olarak döndürülür.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}	GET	Aygıttan gönderilen zaman bilgisini içeri aktarır. Bu seçenek iki eylem için kullanılır: aygıta bilgi isteği göndermek ve asıl aygıt bilgisini almak.
getTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	GET	Veritabanından aygıt zaman bilgilerini içeri aktarır. Kontrol bilgisi yoksa aygıta bir bilgi isteği gönderilmelidir.
updateTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	PUT	Aygıta düzenlenmiş zaman bilgilerini gönderir. Aygıta sadece zaman bilgisindeki düzenlenmiş değerler protokol olarak gönderilir.
getUpdatedTimeInfoResult	/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}	GET	Aygıttan düzenlenmiş aygıt zaman bilgilerini alır. Bu API, getUpdatedTimeInfoResult API’si yürütüldükten sonra yürütülebilir.
listDeviceGroupOrgan	/restapi/v1.0/rms/devices/groups	GET	Organizasyonların listesini içeri aktarır.
listDeviceGroupInfo	/restapi/v1.0/rms/devices/groups/{groupId}	GET	{groupId} grubunun detaylarını içeri aktarır.
listDeviceGroupChild	/restapi/v1.0/rms/devices/groups/{groupId}/child	GET	{groupId} grubunun altındaki alt gruplar hakkındaki bilgileri içeri aktarır.

Kullanıcı

Kullanıcı ekleyip kullanıcı bilgilerini yönetin. Kullanıcılarla ilgili hizmetlere kullanıcı bilgilerini okuma, yazma ve yönetme izni olan doğrulanmış kullanıcıların erişimi vardır.

Mevcut kullanıcı yönetimi hizmetleri şunlardır:

Hizmet Adı	API çağrısı	Çağrı Türü	Açıklama
createUser	/restapi/v1.0/ums/users	POST	Kullanıcı ekler.
listDashboardUserInfo	/restapi/v1.0/ums/users/dashboard	GET	Kontrol panelinden gerekli kullanıcı bilgilerini içeri aktarır.
updateMyInfo	/restapi/v1.0/ums/users/me	PUT	Kullanıcı bilgisini düzenler.
listUserOrgan	/restapi/v1.0/ums/users/organization	GET	Organizasyonların listesini içeri aktarır. Bu seçenek bir grup ağacını yapılandırmak için kullanılabilir.
listUserGroupOrgan	/restapi/v1.0/ums/users/groups	GET	Organizasyonların listesini içeri aktarır.
listUserGroupInfo	/restapi/v1.0/ums/users/groups/{groupId}	GET	{groupId} grubunun detaylarını içeri aktarır.
listUserGroupChild	/restapi/v1.0/ums/users/groups/{groupId}/child	GET	{groupId} grubunun altındaki alt grupların listesini içeri aktarır.

Ayar

Ana işlevlere ek olarak, birçok diğer işlevi kullanarak da etiket ve kategorileri oluşturup yönetebilir ve kontrol panelini düzenleyebilirsiniz.

Hizmet Adı	API çağrısı	Çağrı Türü	Açıklama
getCategoryInfo	/restapi/v1.0/ems/category/{categoryId}	GET	Kategorilerin listesini içeri aktarır.
deleteDashboard	/restapi/v1.0/ems/dashboard	DELETE	Belirli bir kontrol paneli bilgisini siler.
listDashboardInfo	/restapi/v1.0/ems/dashboard	GET	Özelleştirilmiş kontrol panelinde gösterilecek içeriği içeri aktarır. Kontrol panelinde sadece belirli bilgiler gösterilebilir.
updateDashboardPriority	/restapi/v1.0/ems/dashboard	PUT	Kontrol panelinde gösterilen öğelerin sıralamasını değiştirir.
createDashboard	/restapi/v1.0/ems/dashboard/create	GET	Boştaki bir kontrol panelini aktifleştirir.
listDashboardLoginInfo	/restapi/v1.0/ems/dashboard/login	GET	Kontrol panelinde gösterilecek giriş bilgilerini içeri aktarır.
listDashboardNoticeInfo	/restapi/v1.0/ems/dashboard/notice	GET	Kontrol panelinde gösterilecek ilan panosu bilgilerini içeri aktarır.
deleteNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	DELETE	İlan panosundan bir gönderiyi siler.
listEditNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	GET	Seçilen gönderinin detaylarını içeri aktarır.
createNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	POST	İlan panosuna gönderiler ekler.
updateNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	PUT	İlan panosunda seçili gönderiyi düzenler.
listDashboardStorageInfo	/restapi/v1.0/ems/dashboard/storage	GET	Kontrol panelinde gösterilecek depolama bilgilerini içeri aktarır.
listLicense	/restapi/v1.0/ems/license	GET	Sunucudaki kayıtlı lisansların listesini içeri aktarır.
getServerSetupInfo	/restapi/v1.0/ems/setup	GET	Sunucu ayarlarını içeri aktarır. Sunucu ayarı öğeleri, sunucudaki farklı işlevleri kapatıp açabilecek seçenekler içerir.
getTagListInfo	/restapi/v1.0/ems/tag	POST	Sunucuda kayıtlı etiketlerin listesini içeri aktarır.

Open API Detayları (swagger UI)

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

Sv translation

language	sv

I MagicINFO Server kan du implementera innehållshantering, schemahantering, enhetshantering och andra funktioner genom att anropa Open API (v2.0).

Om du vill använda Open API (v2.0) måste du först gå igenom en autentiseringsprocess. Använd en särskild swagger-sida för att testa varje API.

Autentisering

När du anropar alla Open API (v2.0)-objekt, måste api_token ingå i huvudet. Om detta inte tas med returneras felet "401 Unauthorized".

En erhållen token upphör att gälla och blir omöjlig att använda efter en viss tid. Om så är fallet bör du skaffa en ny token.

api_token kan erhållas genom att man anropar följande api.

Servicenamn	API-anrop	Anropstyp	Beskrivning
authenticationRequest	/auth	POST	Importerar ett token-värde för autentisering med hjälp av användar-ID:t och lösenordet.
authenticationRequest	/auth/refresh	GET	Skapar en ny token för att förlänga giltighetstiden. Det är möjligt att anropa REST API utan att logga in igen.

OPEN API (v2.0)

MagicINFO Server Open API (v2.0) innehåller en mängd olika funktioner. Konfiguration av varje funktion visas nedan.

Kategori	Styrenhet	Beskrivning
Innehåll	content-controller	Hantering av innehåll
Innehåll	content-group-controller	Hantering av innehållsgrupper
Spellista	playlist-controller	Hantera spellistor
Spellista	playlist-group-controller	Hantering av spellistegrupper
Schema	content-schedule-controller	Hantering av innehållsscheman
	content-schedule-group-controller	Hantering av grupper av innehållsscheman
	message-schedule-controller	Hantering av meddelandescheman
	message-schedule-group-controller	Hantering av grupper av meddelandescheman
Enhet	device-controller	Enhetshantering
Enhet	device-group-controller	Hantering av enhetsgrupper
Användare	user-controller	Användarhantering
Användare	user-group-controller	Hantering av användargrupper
Inställning	environment-controller	Inställning

Innehåll

Överföra, godkänna och radera innehåll. Hantera innehållslistor. Innehållsrelaterade tjänster är tillgängliga för autentiserade användare med behörighet att läsa, skriva och hantera innehåll.

Följande innehållshanteringstjänster är tillgängliga:

Servicenamn	API-anrop	Anropstyp	Beskrivning
listAllContent	/restapi/v1.0/cms/contents	GET	Importerar en lista med överfört innehåll. Innehållsminiatyrer, namn, filtyper och andra grundläggande uppgifter ingår i listan. Listor kan importeras per sida med hjälp av sidindelningsinformation.
listDashboardContentInfo	/restapi/v1.0/cms/contents/dashboard	GET	Importerar allmän innehållsinformation som ska visas på instrumentpanelen.
listContent	/restapi/v1.0/cms/contents/filter	POST	Importerar en lista med innehåll som filtrerats baserat på villkor. Listor kan importeras per sida med hjälp av sidindelningsinformation.
forceDeleteContent	/restapi/v1.0/cms/contents/force/{contentId}	DELETE	Tar bort innehållet, oavsett om innehållet ingår i en spellista eller ett schema.
deleteContent	/restapi/v1.0/cms/contents/{contentId}	DELETE	Tar bort innehåll efter en kontroll av att innehållet inte ingår i en spellista eller ett schema. Om du försöker ta bort innehåll som ingår i en spellista eller ett schema, tas innehållet inte bort och en felkod returneras.
getActiveContentInfo	/restapi/v1.0/cms/contents/{contentId}	GET	Importerar information om en aktiverad version av ett visst innehåll. Innehållets version uppdateras varje gång innehållet redigeras.
approveContents	/restapi/v1.0/cms/contents/{contentId}/approval	PUT	Godkänner/avvisar innehåll. Godkänt innehåll flyttas till den allmänna innehållslistan och kan användas i spellistor och scheman.
uploadContent	/restapi/v1.0/cms/contents/{groupId}	POST	Överför nytt innehåll.
listDefaultGroup	/restapi/v1.0/cms/contents/groups	GET	Importerar en lista med standardinnehållsgrupper.
getGroup	/restapi/v1.0/cms/contents/groups/{groupId}	GET	Importerar information om gruppen {groupId}.
listChildGroup	/restapi/v1.0/cms/contents/groups/{groupId}/child	GET	Importerar en lista med undergrupper under gruppen {groupId}.

Spellista

Använd innehåll för att skapa, redigera och ta bort spellistor. Spellisterelaterade tjänster är tillgängliga för autentiserade användare med behörighet att läsa, skriva och hantera innehåll.

Följande spellistehanteringstjänster är tillgängliga:

Servicenamn	API-anrop	Anropstyp	Beskrivning
listAllPlaylist	/restapi/v1.0/cms/playlists	GET	Importerar en lista med samtliga spellistor. Spellistenamn, huvudinnehållsminiatyrer, spellistetyper och annan grundläggande information ingår i listan. Listor kan importeras per sida med hjälp av sidindelningsinformation.
createPlaylist	/restapi/v1.0/cms/playlists	POST	Skapa en ny spellista.
getDashboardPlaylistInfo	/restapi/v1.0/cms/playlists/dashboard	GET	Importerar nödvändig spellisteinformation från instrumentpanelen.
listPlaylist	/restapi/v1.0/cms/playlists/filter	POST	Importerar en lista med spellistor som filtrerats baserat på villkor. Listor kan importeras per sida med hjälp av sidindelningsinformation.
deletePlaylist	/restapi/v1.0/cms/playlists/{playlistId}	DELETE	Ta bort den markerade spellistan. Om du försöker ta bort en spellista som ingår i en ett schema, tas spellistan inte bort och en felkod returneras.
getActivePlaylistInfo	/restapi/v1.0/cms/playlists/{playlistId}	GET	Importerar information om en aktiverad version av en spellista. Spellistans version uppdateras varje gång spellistan redigeras.
editPlaylist	/restapi/v1.0/cms/playlists/{playlistId}	PUT	Redigerar spellistan {playlistId}. När en spellista redigeras uppdateras dess version, och den spelare som spelar upp spellistan spelar automatiskt upp den uppdaterade spellistan.
copyPlaylist	/restapi/v1.0/cms/playlists/{playlistId}/copy	PUT	Kopierar spellistan {playlistId}. En kopia av spellistan skapas.
listDefaultGroup	/restapi/v1.0/cms/playlists/groups	GET	Importerar en lista med grupper av standardspellistor.
getGroup	/restapi/v1.0/cms/playlists/groups/{groupId}	GET	Importerar information om gruppen {groupId}.
listChildGroup	/restapi/v1.0/cms/playlists/groups/{groupId}/child	GET	Importerar en lista med undergrupper under gruppen {groupId}.

Schema

Skapa nya innehålls- eller meddelandescheman. Publicera scheman till enheter för uppspelning. Redigera eller ta bort scheman.

Schemarelaterade tjänster är tillgängliga för autentiserade användare med behörighet att läsa, skriva och hantera scheman.

Följande schemahanteringstjänster är tillgängliga:

Servicenamn	API-anrop	Anropstyp	Beskrivning
listContentScheduleAll	/restapi/v1.0/dms/schedule/contents	GET	Importerar en lista med alla innehållsscheman. Innehållsschemanamn, tillkomstdatum, spellistetyper och annan grundläggande information ingår i listan. Listor kan importeras per sida med hjälp av sidindelningsinformation.
createContentSchedule	/restapi/v1.0/dms/schedule/contents	POST	Skapar ett nytt innehållsschema. Ett innehållsschema kan innehålla flera kanaler och ramar. Publicera ett schema till enheter och spela upp önskat innehåll eller en önskad spellista vid en angiven tidpunkt.
listDashboardScheduleInfo	/restapi/v1.0/dms/schedule/contents/dashboard	GET	Import nödvändig innehållsschemainformation från instrumentpanelen.
listContentScheduleByGroup	/restapi/v1.0/dms/schedule/contents/filter	POST	Importerar en lista med innehållsscheman som filtrerats baserat på olika villkor. Listor kan importeras per sida med hjälp av sidindelningsinformation.
deleteContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	DELETE	Ta bort ett innehållsschema. Om du tar bort ett schema som tidigare har publicerats till en enhet, spelar enheten automatiskt upp standardinnehållet.
getProgramInfo	/restapi/v1.0/dms/schedule/contents/{programId}	GET	Importerar information om det markerade schemat.
editContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	PUT	Redigerar ett innehållsschema. Om du redigerar ett schema som tidigare har publicerats till en enhet, spelar enheten automatiskt upp det redigerade schemat.
copyContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/copy	PUT	Kopierar innehållsschemat {programId}. En kopia av innehållsschemat {programId} skapas.
deployContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/deploy	PUT	Publicerar ett innehållsschema till en specifik enhetsgrupp.
getPublishStatus	/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus	GET	Importerar hämtningsstatus för innehållsscheman i realtid från en enhet.
getRootGroups	/restapi/v1.0/dms/schedule/contents/groups	GET	Importerar en lista med rotgrupper för ett innehållsschema.
listContentScheduleGroupInfo	/restapi/v1.0/dms/schedule/contents/groups/{groupId}	GET	Importerar information om gruppen {groupId}.
listAllMessageSchedule	/restapi/v1.0/dms/schedule/messages	GET	Importerar en lista med samtliga meddelandescheman.
createMessageSchedule	/restapi/v1.0/dms/schedule/messages	POST	Skapar ett nytt meddelandeschema.
listMessage	/restapi/v1.0/dms/schedule/messages/filter	POST	Importerar en lista med meddelandescheman som filtrerats baserat på olika villkor. Listor kan importeras per sida med hjälp av sidindelningsinformation.
deleteMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	DELETE	Tar bort det markerade meddelandeschemat. Om du tar bort ett meddelandeschema som tidigare har publicerats till en enhet, tillämpas ändringen automatiskt på enheten.
getMessageInfo	/restapi/v1.0/dms/schedule/messages/{messageId}	GET	Importerar information om det markerade meddelandeschemat.
editMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	PUT	Redigerar det markerade meddelandeschemat. Om du redigerar ett meddelandeschema som tidigare har publicerats till en enhet, tillämpas ändringen automatiskt på enheten.
copyMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/copy	PUT	Kopierar det markerade meddelandeschemat. En kopia av meddelandeschemat skapas.
deployMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/deploy	PUT	Publicerar det markerade meddelandeschemat till en enhetsgrupp.
getRootGroups	/restapi/v1.0/dms/schedule/messages/groups	GET	Importerar en lista med rotgrupper för ett innehållsschema.
listMessageScheduleGroupInfo	/restapi/v1.0/dms/schedule/messages/groups/{groupId}	GET	Importerar information om gruppen {groupId}.
getChildGroups	/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child	GET	Importerar en lista med undergrupper under en specifik grupp.

Enhet

Styr och hantera enheter. Enhetsrelaterade tjänster är tillgängliga för autentiserade användare med behörighet att läsa, skriva och hantera enheter.

Följande enhetshanteringstjänster är tillgängliga:

Servicenamn	API-anrop	Anropstyp	Beskrivning
listAllDevice	/restapi/v1.0/rms/devices	GET	Importerar en lista med samtliga enheter. Enheters strömstatus, information om miniatyrer, enheters felstatus och annan grundläggande information ingår i listan. Listor kan importeras per sida med hjälp av sidindelningsinformation.
getDashboardDeviceInfo	/restapi/v1.0/rms/devices/dashboard	GET	Importerar nödvändig enhetsinformation från instrumentpanelen.
filterDeviceList	/restapi/v1.0/rms/devices/filter	POST	Importerar en lista med enheter som filtrerats baserat på olika villkor. Listor kan importeras per sida med hjälp av sidindelningsinformation.
deleteDevice	/restapi/v1.0/rms/devices/{deviceId}	DELETE	Tar bort den markerade enheten.
getDevice	/restapi/v1.0/rms/devices/{deviceId}	GET	Importerar information om markerade enheter.
approveDevice	/restapi/v1.0/rms/devices/{deviceId}/approval	PUT	Godkänner den markerade enheten för en specifik grupp.
getCabinetList	/restapi/v1.0/rms/devices/{deviceId}/cabinet	POST	Importerar information om Cabinet som är anslutna till en LED-enhet. Den importerade informationen är endast giltig när dina Cabinet är anslutna till en LED-enhet.
updateCabinetInfo	/restapi/v1.0/rms/devices/{deviceId}/cabinet	PUT	Redigerar information om Cabinet som är anslutna till en LED-enhet.
getDisplayControlInfo	/restapi/v1.0/rms/devices/{deviceId}/display	GET	Importerar enhetens skärmstyrningsinformation från databasen. Om det inte finns någon styrningsinformation ska en informationsbegäran skickas till enheten.
updateDisplayInfo	/restapi/v1.0/rms/devices/{deviceId}/display	PUT	Skickar redigerad skärmstyrningsinformation till en enhet. Bara redigerade värden i skärminformationen skickas som ett protokoll till enheten.
getUpdatedDisplayInfoResult	/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}	GET	Tar emot redigerad skärmstyrningsinformation från en enhet. Detta API kan köras efter att API:t updateDisplayInfo har körts.
getGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general	GET	Importerar allmän enhetsinformation från databasen. Allmän enhetsinformation uppdateras när enheten ansluts till servern.
updateGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general/info	PUT	Skickar redigerad enhetsinformation till en enhet. Bara redigerade värden i den grundläggande enhetsinformationen skickas som ett protokoll till enheten.
getUpdatedGeneralInfoResult	/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}	GET	Tar emot redigerad enhetsinformation från en enhet. Detta API kan köras efter att API:t updateGeneralInfo har körts.
moveDevice	/restapi/v1.0/rms/devices/{deviceId}/move	PUT	Flyttar en enhet till en annan grupp.
startRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/start	GET	Skickar ett RM-startprotokoll till en enhet. En enhet som fått ett RM-startprotokoll skickar med jämna mellanrum information via fjärrservern.
stopRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop	GET	Skickar ett RM-stopprotokoll till en enhet. En enhet som fått ett stopprotokoll stoppar motsvarande funktion omedelbart.
getSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	GET	Importerar enhetsinställningar. Enhetens inställningar uppdateras när enheten ansluts till servern.
updateSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	PUT	Skickar redigerade enhetsinställningar till en enhet. Bara redigerade värden i inställningarna skickas som ett protokoll till enheten.
getUpdatedSetupInfoResult	/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}	GET	Tar emot redigerade enhetsinställningar från en enhet. Detta API kan köras efter att API:t updateSetupInfo har körts.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display	GET	Skickar en aktuell begäran om skärmstyrningsinformation till en enhet. Om detta API anropas, returneras requestId som svarsvärde.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}	GET	Importerar skärmstyrningsinformation som skickats från en enhet. Det här alternativet används för två åtgärder: för att skicka en begäran om information till en enhet och för att ta emot själva enhetsinformationen.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time	GET	Skickar en begäran om aktuell tidsinformation till en enhet. Om detta API anropas, returneras requestId som svarsvärde.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}	GET	Importerar tidsinformation som skickats från en enhet. Det här alternativet används för två åtgärder: för att skicka en begäran om information till en enhet och för att ta emot själva enhetsinformationen.
getTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	GET	Importerar tidsinformation för en enhet från databasen. Om det inte finns någon styrningsinformation ska en informationsbegäran skickas till enheten.
updateTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	PUT	Skickar redigerad tidsinformation till en enhet. Bara redigerade värden i tidsinformationen skickas som ett protokoll till enheten.
getUpdatedTimeInfoResult	/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}	GET	Tar emot redigerad enhetstidsinformation från en enhet. Detta API kan köras efter att API:t getUpdatedTimeInfoResult har körts.
listDeviceGroupOrgan	/restapi/v1.0/rms/devices/groups	GET	Importerar en lista med organisationer.
listDeviceGroupInfo	/restapi/v1.0/rms/devices/groups/{groupId}	GET	Importerar information om gruppen {groupId}.
listDeviceGroupChild	/restapi/v1.0/rms/devices/groups/{groupId}/child	GET	Importerar information om undergrupper under {groupId}.

Användare

Lägg till användare och hantera användarinformation. Användarrelaterade tjänster är tillgängliga för autentiserade användare med behörighet att läsa, skriva och hantera användarinformation.

Följande användarhanteringstjänster är tillgängliga:

Servicenamn	API-anrop	Anropstyp	Beskrivning
createUser	/restapi/v1.0/ums/users	POST	Lägger till en användare.
listDashboardUserInfo	/restapi/v1.0/ums/users/dashboard	GET	Importerar nödvändig användarinformation från instrumentpanelen.
updateMyInfo	/restapi/v1.0/ums/users/me	PUT	Redigerar användarinformation.
listUserOrgan	/restapi/v1.0/ums/users/organization	GET	Importerar en lista med organisationer. Det här alternativet kan användas för att konfigurera ett gruppträd.
listUserGroupOrgan	/restapi/v1.0/ums/users/groups	GET	Importerar en lista med organisationer.
listUserGroupInfo	/restapi/v1.0/ums/users/groups/{groupId}	GET	Importerar information om gruppen {groupId}.
listUserGroupChild	/restapi/v1.0/ums/users/groups/{groupId}/child	GET	Importerar en lista med undergrupper under gruppen {groupId}.

Inställning

Förutom huvudfunktionerna kan du använda många andra funktioner till att skapa och hantera taggar och kategorier samt redigera instrumentpanelen.

Servicenamn	API-anrop	Anropstyp	Beskrivning
getCategoryInfo	/restapi/v1.0/ems/category/{categoryId}	GET	Importerar en lista med kategorier.
deleteDashboard	/restapi/v1.0/ems/dashboard	DELETE	Tar bort specifik instrumentpanelsinformation.
listDashboardInfo	/restapi/v1.0/ems/dashboard	GET	Importerar innehåll som ska visas på den anpassade instrumentpanelen. Det går att visa endast specifik information på instrumentpanelen.
updateDashboardPriority	/restapi/v1.0/ems/dashboard	PUT	Ändrar ordning på de objekt som visas på instrumentpanelen.
createDashboard	/restapi/v1.0/ems/dashboard/create	GET	Aktiverar en inaktiv instrumentpanel.
listDashboardLoginInfo	/restapi/v1.0/ems/dashboard/login	GET	Importerar inloggningsinformation som ska visas på instrumentpanelen.
listDashboardNoticeInfo	/restapi/v1.0/ems/dashboard/notice	GET	Importerar anslagstavleinformation som ska visas på instrumentpanelen.
deleteNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	DELETE	Tar bort ett inlägg från anslagstavlan.
listEditNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	GET	Importerar information om det markerade inlägget.
createNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	POST	Lägger till inlägg på anslagstavlan.
updateNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	PUT	Redigerar det markerade inlägget på anslagstavlan.
listDashboardStorageInfo	/restapi/v1.0/ems/dashboard/storage	GET	Importerar lagringsinformation som ska visas på instrumentpanelen.
listLicense	/restapi/v1.0/ems/license	GET	Importerar en lista med licenser som registrerats på servern.
getServerSetupInfo	/restapi/v1.0/ems/setup	GET	Importerar serverinställningar. Serverinställningsobjekt inkluderar alternativ som kan slå på och av olika funktioner på servern.
getTagListInfo	/restapi/v1.0/ems/tag	POST	Importerar en lista med taggar som registrerats på servern.

Open API-information (swagger UI)

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

Content

Space Tools

Page History

Versions Compared

Old Version 95

New Version 96

Key

Authentication

OPEN API (v2.0)

Content

Playlist

Schedule

Device

User

Setting

Open API Details (swagger UI)

Authentication

OPEN API (v2.0)

Content

Playlist

Schedule

Device

User

Setting

Open API Details (swagger UI)

Autenticazione

OPEN API (v2.0)

Contenuto

Playlist

Programma

Dispositivo

Utente

Impostazioni

Dettagli Open API (swagger UI)

Authentifizierung

OPEN API (v2.0)

Inhalt

Wiedergabeliste

Zeitplan

Gerät

Benutzer

Einstellung

Open API-Details (Swagger UI)

驗證

OPEN API (v2.0)

內容

播放清單

排程

裝置

使用者

設定

Open API 詳細資訊 (swagger UI)

Autenticación

OPEN API (versión 2.0)

Contenido

Lista de reproducción

Programación

Dispositivo

Usu.

Configuración

Detalles de Open API (interfaz de usuario de Swagger)

Uwierzytelnianie

OPEN API (v2.0)

Treści

Lista odtwarzania

Harmonogram

Urządzenie

Użytkownik

Ustawienia

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

التصديق

واجهة برمجة التطبيقات المفتوحة (الإصدار 2.0)

المحتوى.

قائمة التشغيل

جدول

الجهاز

المستخدم

الضبط

تفاصيل واجهة برمجة التطبيقات المفتوحة (واجهة مستخدم Swagger)

Authentification