Page History
...
MagicInfo Server에서는 콘텐츠 관리, 스케줄 관리, 장치 관리 등 각 기능을 REST Open API 호출을 통하여 구현할 수 있습니다.
REST API를 Open API를 사용하기 위해서는 먼저 인증 절차를 거쳐야 하며, 별도의 swagger 페이지를 통해 각 API를 테스트 할 수 있습니다.
Authentication
모든 REST API Open API 호출 시 헤더에 api_token을 포함하여야 하며, 그렇지 않은 경우 '401 Unauthorized.' 에러를 받게 됩니다.
...
api_token은 아래 api 호출을 통해 발급받을 수 있습니다.
| Service Name | API | ||
|---|---|---|---|
call | Call Type | ||
| Description | |||
| authenticationRequest | /auth | POST | 사용자 |
REST API
...
| ID 및 비밀번호를 이용하여 인증을 위한 토큰 값을 가져옵니다. | |||
| authenticationRequest | /auth/refresh | GET | 토큰을 새로 생성하여 만료시간을 연장합니다. 재 로그인 없이 계속해서 REST API를 호출할 수 있습니다. |
OPEN API
매직인포 서버 Open API는 여러가지 기능을 제공하며 기능별 구성은 아래와 같습니다.
| 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 | 사용자 그룹 관리 | |
| Setting | environment-controller | 환경 설정 |
Authentication
각 REST API를 호출하기 전, 인증을 위한 토큰을 발급 받아야 합니다. 각 토큰을 관리하는 서비스는 아래와 같습니다.
...
API call
...
/auth
...
/auth/refresh
...
Content
콘텐츠 업로드, 승인, 삭제, 리스트 관리 등 콘텐츠를 관리할 수 있습니다. 콘텐츠 관련 서비스는 인증을 받은 사용자가 콘텐츠 읽기/쓰기/관리 권한을 가져야만 접근할 수 있습니다.
...