Zone API를 사용하면 HRA, ECA, JWC, 사용자 정의 해상 구역 정보를 빠르게 조회할 수 있습니다.
해상 위험 분석, 환경 규제 대응, 맞춤형 경고 시스템 구축 등 다양한 목적에 활용할 수 있습니다.
1. 인증 방법
Swagger UI를 통해 API 요청 전 인증을 완료해야 합니다.
Basic 인증 방식을 사용하며, 다음 절차를 따릅니다.
1.
Swagger 문서 접속
2.
우측 상단의 [Authorize] 버튼 클릭
3.
제공된 ID와 Password 입력
4.
[Authorize] 버튼 재클릭 후 [Close] 클릭
인증이 완료되면 이후 요청에 인증 정보가 자동으로 포함됩니다.
2. 요청 정보
2-1. 요청 정보
Request URL : [GET] https://insight.seavantage.com/api/zone/{zoneSection}
2-2. 실행 순서
1.
2.
/zone/{zoneSection} 경로로 이동
3.
[Try it out] 버튼을 클릭 → 입력창 활성화
4.
zoneSection 필드에 원하는 구역 코드를 입력 (예: ECA)
•
사용 가능한 구역 코드는 아래와 같습니다:
구역 코드 | 설명 |
HRA | 고위험 구역 (High Risk Area) |
ECA | 배출 규제 지역 (Emission Control Area) |
JWC | 전쟁 위험 지역 (Joint War Committee) |
CUSTOM_ZONE | 사용자 정의 구역 |
5.
[Execute] 버튼을 클릭
6.
하단 응답 영역에서 결과 확인
3. 응답 정보
응답 예시
{
"code": 200,
"message": "OK",
"error": false,
"timestamp": "2024-12-01T12:00:00",
"response": [
{
"zoneSection": "JWC",
"zoneName": "Zone name",
"latitude": 12.345678,
"longitude": 98.765432,
"radiusLength": 100,
"shapeType": "Polygon",
"geoData": "{\"type\":\"Polygon\",\"coordinates\":[[[102.0,2.0],[103.0,2.0],[103.0,3.0],[102.0,3.0],[102.0,2.0]]]}",
"enabled": true}
]
}
JSON
복사
응답 필드 상세 설명
응답 항목별 정의
필드명 | 예시 값 | 설명 |
code | 200 | 응답 상태 코드 (HTTP status code와 동일하게 사용됨)코드 목록은 아래 참조 |
message | "OK" | 응답 메시지 (상태에 따른 설명) |
error | false | 오류 여부 (true: 오류 발생, false: 정상 처리) |
timestamp | "2025-05-14T01:09:00.834665213" | 응답 생성 시각 (UTC 기준) |
response | 배열 또는 빈배열 | 영역 존재시 배열, 미존재시 빈배열 |
응답 코드 종류
코드 | 설명 |
200 | 정상 처리 (Success) |
400 | 잘못된 파라미터 (Bad request) |
401 | 인증 필요 (Unauthorized) |
403 | 권한 없음 (Forbidden) |
422 | 처리 불가 (Unprocessable entity) |
429 | 요청 과다 (Too many requests) |
응답 상세 설명
Depth 1 필드 설명 (response 객체)
필드명 | 예시 값 | 설명 | 데이터 타입 |
zoneSection | JWC | 구역 종류 (HRA, ECA, JWC 등) | varchar(32) |
zoneName | Nigeria | 구역 이름 | varchar(128) |
latitude | 25.0125 | 위도 | numeric(12,8) |
longitude | 51.5299 | 경도 | numeric(12,8) |
radiusLength | 100 | 반경 길이 (단위: m) | integer |
shapeType | Polygon | 구역 형태 | varchar(32) |
geoData | "\"type\":\"Polygon\",\"coordinates\":[[[102.0,2.0],[103.0,2.0],[103.0,3.0],[102.0,3.0],[102.0,2.0]]]}” | 구역의 상세 위치 데이터 | text |
enabled | true | 구역 활성화 상태
true = 활성화 (enabled)
false = 비활성화 (disabled) | boolean |
관련 링크