You have English selected as language but this page has not been translated yet. Translate the page or view the content in the default space language below.
Display defaultAuthentication
모든 rest api 호출 시 헤더에 api_token을 포함하여야 합니다. 그렇지 않은 경우 '401 Unauthorized.' 에러를 받게 됩니다.
api_token은 아래 api 호출을 통해 얻을 수 있습니다.
Service Name | API Call | Call Type | Call Description |
|---|---|---|---|
Authentication | /auth | POST | 사용자 아이디와 비밀번호 정보로 토큰을 생성합니다. |
REST API
매직인포 서버 REST API는 여러가지 기능을 제공하며 기능별 rest api는 아래와 같습니다. 각 api의 상세 정보는 아래 swagger api list에 자세히 설명되어 있습니다.
- Category 별 controller
| Category | Controller | Description |
|---|---|---|
| Authetication | authentication-controller | 인증 관련 |
| Content | content-controller | 콘텐츠 관리 |
| content-group-controller | 콘텐츠 그룹 관리 | |
| Playlist | playlist-controller | 플레이리스트 관리 |
| playlist-group-controller | 플레이리스트 그룹 관리 | |
| Schedule | content-schedule-controller | 콘텐츠 스케줄 관리 |
| content-schedule-group-controller | 콘텐츠 스케줄 그룹 관리 | |
| message-schedule-controller | 메시지 스케줄 관리 | |
| message-schedule-group-controller | 메시지 스케줄 그룹 관리 | |
| Device | device-controller | 장치 관리 |
| device-group-controller | 장치 그룹 관리 | |
| User | user-controller | 사용자 관리 |
| user-group-controller | 사용자 그룹 관리 | |
| Etc | environment-controller | 환경 설정 |
- controllter 별 API
| Controller | Service Name | API call | Description |
|---|---|---|---|
| authentication-controller | authenticationRequest | POST /auth | 인증을 위한 토큰 값을 가져옵니다. |
| authenticationRequest | GET /auth/refresh | 토큰을 새로 생성하여 만료시간을 연장합니다. | |
| content-controller | listAllContent | GET /restapi/v1.0/cms/contents | 모든 콘텐츠 목록을 가져옵니다. |
| listDashboardContentInfo | GET /restapi/v1.0/cms/contents/dashboard | 대쉬보드에서 필요한 콘텐츠 관련 정보를 가져옵니다. | |
| listContent | POST /restapi/v1.0/cms/contents/filter | 여러 조건으로 필터링된 콘텐츠 리스트를 가져옵니다. | |
| forceDeleteContent | DELETE /restapi/v1.0/cms/contents/force/{contentId} | 콘텐츠의 사용여부에 상관없이 콘텐츠를 삭제합니다. | |
| deleteContent | DELETE /restapi/v1.0/cms/contents/{contentId} | 삭제 가능한 콘텐츠인지 확인 후 콘텐츠를 삭제합니다. | |
| getActiveContentInfo | GET /restapi/v1.0/cms/contents/{contentId} | 활성화된 버전의 콘텐츠 상세 정보를 가져옵니다. | |
| approveContents | PUT /restapi/v1.0/cms/contents/{contentId}/approval | 미승인 상태의 콘텐츠를 승인/반려합니다. | |
| uploadContent | POST /restapi/v1.0/cms/contents/{groupId} | 새 콘텐츠를 업로드합니다. | |
| content-group-controller | listDefaultGroup | GET /restapi/v1.0/cms/contents/groups | 콘텐츠 기본 그룹 목록을 가져옵니다. |
| getGroup | GET /restapi/v1.0/cms/contents/groups/{groupId} | {groupId} 그룹의 상세 정보를 가져옵니다. | |
| listChildGroup | GET /restapi/v1.0/cms/contents/groups/{groupId}/child | {groupId} 그룹의 하위 그룹 목록을 가져옵니다. | |
| playlist-controller | listAllPlaylist | GET /restapi/v1.0/cms/playlists | 모든 플레이리스트 목록을 가져옵니다. |
| createPlaylist | POST /restapi/v1.0/cms/playlists | 새 플레이리스트를 생성합니다. | |
getDashboardPlaylistInfo | GET /restapi/v1.0/cms/playlists/dashboard | 대쉬보드에 필요한 플레이리스트 정보를 가져옵니다. | |
listPlaylist | POST /restapi/v1.0/cms/playlists/filter | 여러 조건으로 필터링된 플레이리스트 목록을 가져옵니다. | |
deletePlaylist | DELETE /restapi/v1.0/cms/playlists/{playlistId} | 선택된 플레이리스트를 삭제합니다. | |
getActivePlaylistInfo | GET /restapi/v1.0/cms/playlists/{playlistId} | 활성화된 버전으로 플레이리스트의 상세 정보를 가져옵니다. | |
editPlaylist | PUT /restapi/v1.0/cms/playlists/{playlistId} | 플레이리스트를 수정합니다. | |
copyPlaylist | PUT /restapi/v1.0/cms/playlists/{playlistId}/copy | 플레이리스트를 복사합니다. | |
| playlist-group-controller | listDefaultGroup | GET /restapi/v1.0/cms/playlists/groups | 플레이리스트 기본 그룹 목록을 가져옵니다. |
getGroup | GET /restapi/v1.0/cms/playlists/groups/{groupId} | {groupId} 그룹의 상세 정보를 가져옵니다. | |
| listChildGroup | GET /restapi/v1.0/cms/playlists/groups/{groupId}/child | {groupId} 그룹의 하위 그룹 목록을 가져옵니다. | |
| content-schedule-controller | listContentScheduleAll | GET /restapi/v1.0/dms/schedule/contents | 모든 콘텐츠 스케줄 목록을 가져옵니다. |
| createContentSchedule | POST /restapi/v1.0/dms/schedule/contents | 새 콘텐츠 스케줄을 생성합니다. | |
| listDashboardScheduleInfo | GET /restapi/v1.0/dms/schedule/contents/dashboard | 대쉬보드에서 필요한 콘텐츠 스케줄 정보를 가져옵니다. | |
| listContentScheduleByGroup | POST /restapi/v1.0/dms/schedule/contents/filter | 여러 조건으로 필터링된 콘텐츠 스케줄 목록을 가져옵니다. | |
| deleteContentSchedule | DELETE /restapi/v1.0/dms/schedule/contents/{programId} | 콘텐츠 스케줄을 삭제합니다. | |
| getProgramInfo | GET /restapi/v1.0/dms/schedule/contents/{programId} | 선택된 스케줄의 상세 정보를 가져옵니다. | |
| editContentSchedule | PUT /restapi/v1.0/dms/schedule/contents/{programId} | 콘텐츠 스케줄을 수정합니다. | |
| copyContentSchedule | PUT /restapi/v1.0/dms/schedule/contents/{programId}/copy | 콘텐츠 스케줄을 복사합니다. | |
| deployContentSchedule | PUT /restapi/v1.0/dms/schedule/contents/{programId}/deploy | 콘텐츠 스케줄을 원하는 장치 그룹에 배포합니다. | |
| getPublishStatus | GET /restapi/v1.0/dms/schedule/contents/{programId}/publishStatus | 장치에서 콘텐츠 스케줄을 다운로드 받는 상태를 실시간으로 가져옵니다. | |
| content-schedule-group-controller | getRootGroups | GET /restapi/v1.0/dms/schedule/contents/groups | 콘텐츠 스케줄의 루트 그룹 리스트를 가져옵니다. |
| listContentScheduleGroupInfo | GET /restapi/v1.0/dms/schedule/contents/groups/{groupId} | {groupId} 그룹에 대한 상세 정보를 가져옵니다. | |
| message-schedule-controller | listAllMessageSchedule | GET /restapi/v1.0/dms/schedule/messages | 모든 메시지 스케줄 목록을 가져옵니다. |
| createMessageSchedule | POST /restapi/v1.0/dms/schedule/messages | 새 메시지 스케줄을 생성합니다. | |
| message-schedule-group-controller | getRootGroups | GET /restapi/v1.0/dms/schedule/messages/groups | 콘텐츠 스케줄의 루트 그룹 리스트를 가져옵니다. |
| listMessageScheduleGroupInfo | GET /restapi/v1.0/dms/schedule/messages/groups/{groupId} | {groupId} 그룹에 대한 상세 정보를 가져옵니다. | |
| device-controller | listAllDevice | GET /restapi/v1.0/rms/devices | 모든 장치 목록을 가져옵니다. |
| getDashboardDeviceInfo | GET /restapi/v1.0/rms/devices/dashboard | 대쉬보드에서 필요한 장치 정보를 가져옵니다. | |
| device-group-controller | listDeviceGroupOrgan | GET /restapi/v1.0/rms/devices/groups | 소속의 리스트를 가져옵니다. |
| listDeviceGroupInfo | GET /restapi/v1.0/rms/devices/groups/{groupId} | {groupId} 그룹에 대한 상세 정보를 가져옵니다. | |
| user-controller | createUser | POST /restapi/v1.0/ums/users | 새 사용자를 추가합니다. |
| listDashboardUserInfo | GET /restapi/v1.0/ums/users/dashboard | 대쉬보드에 필요한 사용자의 정보를 가져옵니다. | |
| user-group-controller | listUserGroupOrgan | GET /restapi/v1.0/ums/users/groups | 소속 목록을 가져옵니다. |
| listUserGroupInfo | GET /restapi/v1.0/ums/users/groups/{groupId} | {groupId} 그룹에 대한 상세 정보를 가져옵니다. | |
| environment-controller | getCategoryInfo | GET /restapi/v1.0/ems/category/{categoryId} | 카테고리 목록을 가져옵니다. |
| deleteDashboard | DELETE /restapi/v1.0/ems/dashboard | 특정 대쉬보드 정보를 삭제합니다. |