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 | Service Name | API call | Description |
|---|---|---|---|---|
| Authetication | authentication-controller | authenticationRequest | POST /auth | 인증을 위한 토큰 값을 가져옵니다. |
| authenticationRequest | GET /auth/refresh | 토큰을 새로 생성하여 만료시간을 연장합니다. | ||
| Content | content-controller | listAllContent | GET /restapi/v1.0/cms/contents | 모든 콘텐츠 목록을 가져옵니다. |
| listDashboardContentInfo | GET /restapi/v1.0/cms/contents/dashboard | 대쉬보드에서 필요한 콘텐츠 관련 정보를 가져옵니다. | ||
| 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 | playlist-controller | listAllPlaylist | GET /restapi/v1.0/cms/playlists | 모든 플레이리스트 목록을 가져옵니다. |
| createPlaylist | POST /restapi/v1.0/cms/playlists | 새 플레이리스트를 생성합니다. | ||
| 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} 그룹의 하위 그룹 목록을 가져옵니다. | ||
| Schedule | 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 | 대쉬보드에서 필요한 콘텐츠 스케줄 정보를 가져옵니다. | ||
| 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 | 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 | 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} 그룹에 대한 상세 정보를 가져옵니다. | ||
| Etc | environment-controller | getCategoryInfo | GET /restapi/v1.0/ems/category/{categoryId} | 카테고리 목록을 가져옵니다. |
| deleteDashboard | DELETE /restapi/v1.0/ems/dashboard | 특정 대쉬보드 정보를 삭제합니다. |