Zone API는 HRA, ECA, JWC 및 사용자 정의 구역의 공간 범위와 속성 정보를 JSON 형식으로 제공하여 해상 위험 분석과 경계 구역 시각화에 활용할 수 있습니다.
1. 인증 방법
Zone API는 사용자 인증을 위해 Swagger UI에서 Basic Authorize 인증 방식을 제공합니다.
인증 절차는 다음과 같습니다:
1.
우측 상단의 [Authorize] 버튼을 클릭합니다.
2.
팝업 창에 제공받은 인증 정보(아이디, 비밀번호)를 입력합니다.
3.
입력 후 다시 [Authorize] 버튼을 클릭하여 인증을 진행합니다.
4.
인증이 완료되면 [Close] 버튼을 클릭하여 인증 창을 닫습니다.
Swagger UI에서 호출되는 모든 API 요청에 인증 토큰이 자동으로 포함되어 전송됩니다.
2. 요청 정보
2-1. 요청 정보
Request URL : [GET] https://insight.seavantage.com/api/zone/all
2-2. 실행 순서
1.
Swagger 문서에서 우측 상단의 Select a definition 메뉴에서 Zone 선택
2.
/zone/all 경로로 이동
3.
[Try it out] 클릭 → 입력창 활성화
4.
[Execute] 버튼 클릭
5.
하단 응답 영역에서 등록 결과 확인
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",
"properties": "MTISC",
"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 | success | 응답 메시지 (상태에 따른 설명) |
error | false | 오류 여부
(true: 오류 발생, false: 정상 처리) |
timestamp | 2025-05-15T10:56:59.034880881 | 응답 생성 시각 (UTC 기준) |
response | null 또는 Object | 응답 본문 데이터
화물 존재시 데이터 객체, 미존재시 null |
응답 코드 종류
코드 | 설명 |
200 | 정상 처리 (Success) |
400 | 잘못된 파라미터 (Bad request) |
401 | 인증 필요 (Unauthorized) |
403 | 권한 없음 (Forbidden) |
422 | 처리 불가 (Unprocessable entity) |
429 | 요청 과다 (Too many requests) |
응답 상세 설명
Depth 1 필드 설명 (response 객체)
필드명 | 예시 값 | 설명 | 데이터 타입 |
zoneSection | JWC | HRA = 고위험 구역
ECA = 배출 규제 지역
JWC= 전쟁 위험 지역CUSTOM_ZONE = 사용자 정의 영역 | varchar(32) |
zoneName | Nigeria | 구역 이름 | varchar(128) |
latitude | 12.345678 | 위도 | numeric(12,8) |
longitude | 98.765432 | 경도 | numeric(12,8) |
radiusLength | 100 | 영역 지름 | integer |
shapeType | POLYGON | zone의 형태 | varchar(32) |
properties | 2 | 구역 관련 속성 정보 | varchar(2056) |
geoData | {\"type\":\"Polygon\",\"coordinates\":[[[102.0,2.0],[103.0,2.0],[103.0,3.0],[102.0,3.0],[102.0,2.0]]]} | 항구 구역 GeoData | text |
enabled | true | 구역 활성화 상태
true = 활성화 (enabled)
false = 비활성화 (disabled) | boolean |