19. Open API 관리
해당 Chapter에서는 HONE Smart Platform의 Operations Center Admin을 이용하여 Open API 사용을 위한 Key 관리에 대해 설명한다.
Open API 관리 기능을 이용하여 기 등록된 Open API의 정보 조회 및 변경이 가능하며 Open API 상세 화면에서 기능을 제공한다.
Open API 상세 화면의 진입 절차는 다음과 같으며 지원하는 Open API별 목록 구성 및 상세 화면이 상이하지 않기때문에 Address 화면을 예시로 설명한다.
- Login 성공 후 최초 화면에서 상단 메뉴 중 “Open API” 메뉴를 선택한다.
- Open API의 좌측 화면에서 변경을 원하는 종류를 선택한다.
주소검색 (Address)
날씨정보 (Weather)
대기오염 (Air Pollution)
- 아래와 같이 선택한 Open API 목록이 출력되며 변경을 원하는 Open API 항목을 선택한다.
- Open API의 상세 화면은 다음과 같이 출력된다.
Key Name 변경
Open API의 상세 화면에서 기존에 작성된 Key Name의 변경이 가능하다.
해당 Key Name은 Client에서 출력되는 항목은 아니며 Open API 목록 관리를 목적으로 사용된다.
변경하는 절차는 다음과 같다.
- Open API의 상세 화면으로 이동한다. (Open API 관리 참조)
- Key Name 항목에 변경하고자 하는 텍스트를 입력한다.
- 우측하단에 “Update” 버튼을 선택한다.
- Update결과 팝업이 출력되며 적용 여부를 확인한다.
App Name 변경
Open API의 상세 화면에서 대상이 되는 App의 Name 변경이 가능하다.
변경하는 절차는 다음과 같다.
- Open API의 상세 화면으로 이동한다. (Open API 관리 참조)
- ID항목에 변경하고자 하는 App의 Name를 선택한다.
- 우측하단에 “Update” 버튼을 선택한다.
- Update결과 팝업이 출력되며 적용 여부를 확인한다.
End Date 변경
Open API의 상세 화면에서 기존에 작성된 End Date의 변경이 가능하다.
변경하는 절차는 다음과 같다.
- Open API의 상세 화면으로 이동한다. (Open API 관리 참조)
- End Date 항목에 시작 일자 또는 종료일자를 변경한다
- 우측하단에 “Update” 버튼을 선택한다.
- Update결과 팝업이 출력되며 적용 여부를 확인한다.
Description 변경
Open API의 상세 화면에서 기존에 작성된 Description의 변경이 가능하다.
해당 Description은 Client에서 출력되는 항목은 아니며 필요 시 Open API 항목에 대한 추가적인 정보 작성을 목적으로 사용된다.
변경하는 절차는 다음과 같다.
- Open API의 상세 화면으로 이동한다. (Open API 관리 참조)
- Description 항목에 변경하고자 하는 텍스트를 입력한다.
- 우측하단에 “Update” 버튼을 선택한다.
- Update결과 팝업이 출력되며 적용 여부를 확인한다.