Zone API를 사용하면 HRA, ECA, JWC, 사용자 정의 해상 구역 정보를 빠르게 조회할 수 있습니다.
해상 위험 분석, 환경 규제 대응, 맞춤형 경고 시스템 구축 등 다양한 목적에 활용할 수 있습니다.
인증 방법
Swagger UI를 통해 API 요청 전 인증을 완료해야 합니다.
Basic 인증 방식을 사용하며, 다음 절차를 따릅니다.
1.
Swagger 문서 접속
2.
우측 상단의 [Authorize] 버튼 클릭
3.
제공된 ID와 Password 입력
4.
[Authorize] 버튼 재클릭 후 [Close] 클릭
인증이 완료되면 이후 요청에 인증 정보가 자동으로 포함됩니다.
Zone 정보 조회하는 방법
1. 구역 코드 선택
사용 가능한 구역 코드는 다음과 같습니다.
구역 코드 | 설명 |
HRA | 고위험 구역 (High Risk Area) |
ECA | 배출 규제 지역 (Emission Control Area) |
JWC | 전쟁 위험 지역 (Joint War Committee) |
CUSTOM_ZONE | 사용자 정의 구역 |
2. Swagger UI에서 요청 실행
1.
one/{zoneSection} 경로 선택
2.
[Try it Out] 클릭
3.
zoneSection 필드에 구역 코드 입력 (예: ECA)
4.
[Execute] 클릭 후 하단 응답 확인
응답 정보
응답 형식 예시
json
복사편집
{
"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
복사
주요 필드 설명
필드명 | 예시 값 | 설명 |
zoneSection | JWC | 구역 종류 (HRA, ECA, JWC 등) |
zoneName | Nigeria | 구역 이름 |
latitude / longitude | 12.345678 / 98.765432 | 중심 좌표 |
radiusLength | 100 | 반경 길이 (단위: m) |
shapeType | Polygon | 구역 형태 |
geoData | GeoJSON 형식 | 구역의 상세 위치 데이터 |
enabled | true | 구역 활성 여부 |
응답 코드 안내
코드 | 의미 |
200 | 성공 |
400 | 잘못된 요청 |
401 | 인증 필요 |
403 | 접근 권한 없음 |
422 | 처리 불가 |
429 | 요청 횟수 초과 |