Page History
...
REST API를 사용하기 위해서는 먼저 인증 절차를 거쳐야 하며, 별도의 swagger 페이지를 통해 각 API를 테스트 하실 할 수 있습니다.
Authentication
모든 REST API 호출 시 헤더에 api_token을 포함하여야 하며, 그렇지 않은 경우 '401 Unauthorized.' 에러를 받게 됩니다.
발급 받은 토큰은 정해진 일정 시간이 지나면 만료되어 사용이 중지되며, 그 경우 토큰을 새로 발급 받아야 합니다.
api_token은 아래 api 호출을 통해 얻을 발급받을 수 있습니다.
Service Name | API Call | Call Type | Call Description |
|---|---|---|---|
Authentication | /auth | POST | 사용자 아이디와 비밀번호 정보로 토큰을 생성합니다. |
...
| 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 | 사용자 그룹 관리 | |
| EtcSetting | environment-controller | 환경 설정 |
...
| 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
주요 기능 이외에도 태그, 카테고리를 생성, 관리하고 대시보드를 수정하는 등 다양한 기능을 구현할 수 있습니다.
...