1. 개요
1.1. 목적
- 본 개발가이드는 현 시스템이 제공하고 있는 해양위성정보를 OPEN API 를 통해 손쉽게 사용할 수 있도록 하는데 목적이 있습니다.
1.2. API 호출 절차
- 1) 사용자가 API키 발급 요청을 하면 인증키가 2~3일 내로 메일을 통해 키 발급이 된다. 사용자 별로 API키 발급은 1개만 발급합니다.
- 3) 취득한 인증키를 이용하여 본 시스템에서 제공하는 모든 해양위성정보 OPEN API 서비스 호출합니다.
- 4) 관리자는 필요한 경우, 경우에 따라 API 사용을 제한하거나 인증키를 삭제합니다.
1.3. 사용 제한
- - 상업적 이용이 불가능한 API에 대해 상업적으로 활용한 경우
- - 또는 트래픽 초과로 인해 사스템이 부하가 발생할 경우 관리자가 사용을 제한할 수 있습니다.
- - API는 부하를 고려하여 일일 20000건으로 제한되어 있습니다.
- - API요청 건수를 늘리고자 하는 사용자 또는 활용기관은 관리자와 협의를 통해 진행하실 수 있습니다.
1.4. 개발환경
- - OPEN API 는 누구나 쉽게 사용할 수 있도록 자바스크립트 형태로 제공하여 별도의 개발환경 제한을 두고 있지 않음
- - Explorer 8.0 이상, Crome, FireFox, Safari 지원
- - REST(Representation State Transfer) 방식으로 서비스 제공
1.5. 문의사항
- - 본 사이트에서 제공하는 API에 대해 문의사항을 우리원 홈페이지 자유게시판으로 보내주시면 성실히 답변드리겠습니다.
2. 사용 예제
2.1. 요청/응답 메시지
- 요청주소 http://www.khoa.go.kr/nosc/satellite/api/meta/search.do?ServiceKey=인증키&startDate=20201222&endDate=20201223&slot=2&ResultType=json
요청변수(Request Parameter)
| 항목명(영문) | 항목명(국문) | 샘플데이터 | 비고 |
|---|---|---|---|
| ServiceKey | 인증키 | a0f388e85ec2f9f259e1d25247106f5db144f94fc34e4927a8c4ecd51bd433d1 | |
| startDate | 검색 시작일자 | 20201020 | |
| endDate | 검색 종료일자 | 20201022 | |
| slot | 영상 슬롯번호 | 2 | 슬롯번호 0~11 (13번 : 한반도 전체 영역 영상 슬롯번호) |
| ResultType | 결과타입 | json, xml |
출력결과 (Response Element)
| 항목명(영문) | 항목명(국문) | 샘플데이터 | 비고 |
|---|---|---|---|
| Satellite | 위성 | GK2B | |
| Sensor | 센서 | GOCI-II | |
| Level | 레벨 | L1B | |
| ObsArea | 관측영역 | 한반도 | |
| fileName | 파일명 | GK2_GOCI2_L1B_20201027_081500_RLA_1.jpg | |
| slot | 영상 슬롯번호 | 2 | 슬롯번호 0~11 (13번 : 한반도 전체 영역 영상 슬롯번호) |
| product | 산출물 | AC |
AC: 대기보정
IOP:고유 광특성 산출물 Kd:하향 확산 감쇠 계수 Zsd:세키깊이 SSC:표층 해류 CF:해양 전선 LSSS:저염분수 SI:해빙 Chl:엽록소농도 RI:적조 지수 FA:부유 조류 FGI:어장환경지수 PP:해양 일차 생산력 CDOM:용존 유기물 TSS:총 부유물 농도 MF:해무 AOD:에어로졸 광학 두께 SRL:육상지표반사도 LSAB:육상알베도-광대역 LSAN:육상알베도-협대역 VI:식생지수 LCC:토지피복 |
| ObsTime(UTC) | 관측시간(UTC) | 2020-10-27 17:15:00 UTC | |
| ObsTime(KST) | 관측시간(KST) | 2020-10-27 17:15:00 KST | |
| MetaData | 메타 데이터 | 정보보기 |
2.2. 응답 메시지(JSON)
