Zone API는 HRA, ECA, JWC 및 사용자 정의 구역의 공간 범위와 속성 정보를 JSON 형식으로 제공하여 해상 위험 분석과 경계 구역 시각화에 활용할 수 있습니다.
인증 방법
Zone API는 Swagger UI를 통한 Basic 인증 방식을 제공합니다.
인증 절차
1.
Swagger 문서를 엽니다.
2.
화면 우측 상단의 [Authorize] 버튼을 클릭합니다.
3.
팝업창에 제공된 아이디와 비밀번호를 입력합니다.
4.
다시 [Authorize] 버튼을 눌러 인증을 완료합니다.
5.
인증 완료 후 [Close] 버튼을 눌러 창을 닫습니다.
인증이 완료되면 이후 API 요청에 인증 토큰이 자동으로 포함됩니다.
요청 URL
pgsql
[GET] https://insight.seavantage.com/api/zone/all
Plain Text
복사
실행 순서
1.
Swagger 문서에서 우측 상단의 Select a definition 메뉴에서 Zone 선택
2.
/zone/all 항목 클릭
3.
[Try it Out] 버튼 클릭
4.
[Execute] 버튼 클릭
5.
하단 응답 영역에서 결과 확인
문서 링크: Swagger 문서 바로가기
응답 정보
응답 예시
{
"code": 200,
"message": "OK",
"error": false,
"timestamp": "2024-12-01T12:00:00",
"response": [
{
"workspaceId": "123e4567-e89b-12d3-a456-426614174000",
"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 | OK | 요청 처리 결과 메시지 |
error | false | 오류 여부 (true: 오류 발생, false: 정상 처리) |
timestamp | 2025-05-15T10:56:59.034880881 | 응답 생성 시각 (UTC 기준) |
response | 배열 또는 null | 구역 정보가 포함된 데이터 객체 또는 없음(null) |
응답 코드 종류 (code 필드 기준)
코드 | 설명 |
200 | 요청이 성공적으로 처리되었습니다. |
201 | 요청이 정상적으로 완료되었으며, 리소스가 생성되었습니다. |
400 | 파라미터가 잘못되었거나 형식이 유효하지 않습니다. |
401 | 인증이 필요합니다. |
403 | 접근 권한이 없습니다. |
422 | 서버가 요청을 이해했으나 처리할 수 없습니다. |
429 | 요청 횟수가 초과되었습니다. |
Depth 1 필드 설명
필드명 | 예시 | 설명 |
workspaceId | 123e4567-e89b-12d3-a456-426614174000 | CUSTOM_ZONE 구역인 경우 UUID 형식으로 제공됨 |
zoneSection | JWC | 구역 유형 (HRA, ECA, JWC, CUSTOM_ZONE 등) |
zoneName | Nigeria | 구역 이름 |
latitude | 12.345678 | 중심 위도 좌표 |
longitude | 98.765432 | 중심 경도 좌표 |
radiusLength | 100 | 구역 반경 길이 (단위: m) |
shapeType | Polygon | 구역 형상 (POLYGON, CIRCLE 등) |
properties | MTISC | 구역 관련 속성 정보 |
geoData | GeoJSON 문자열 | 구역 좌표 데이터 (GeoJSON 형식) |
enabled | true | 구역 활성화 여부 |
Zone API는 HRA, ECA, JWC, 사용자 정의 구역(CUSTOM_ZONE)을 포함한 다양한 해상 구역 정보를 동시에 조회할 수 있도록 지원합니다.
각 구역의 공간 범위 및 속성 정보를 JSON 형식으로 반환하며, 해상 위험 분석 및 경계 구역 시각화 등에 활용하실 수 있습니다.
인증 방법
Zone API는 Swagger UI를 통한 Basic 인증 방식을 제공합니다.
인증 절차
1.
Swagger 문서를 엽니다.
2.
화면 우측 상단의 [Authorize] 버튼을 클릭합니다.
3.
팝업창에 제공된 아이디와 비밀번호를 입력합니다.
4.
다시 [Authorize] 버튼을 눌러 인증을 완료합니다.
5.
인증 완료 후 [Close] 버튼을 눌러 창을 닫습니다.
인증이 완료되면 이후 API 요청에 인증 토큰이 자동으로 포함되어 전송됩니다.
요청 정보
1. 요청 URL
pgsql
복사편집
[GET] https://insight.seavantage.com/api/zone/all
Plain Text
복사
2. 실행 순서
1.
Swagger 문서에서 우측 상단의 Select a definition 메뉴에서 Zone을 선택합니다.
2.
/zone/all 항목을 클릭합니다.
3.
[Try it Out] 버튼을 클릭하여 입력창을 활성화합니다.
4.
[Execute] 버튼을 클릭합니다.
5.
하단 응답 영역에서 결과를 확인합니다.
문서 링크: Swagger 문서 바로가기
응답 정보
응답 예시
json
복사편집
{
"code": 200,
"message": "OK",
"error": false,
"timestamp": "2024-12-01T12:00:00",
"response": [
{
"workspaceId": "123e4567-e89b-12d3-a456-426614174000",
"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 | OK | 요청 처리 결과 메시지 |
error | false | 오류 여부 (true: 오류 발생, false: 정상 처리) |
timestamp | 2025-05-15T10:56:59.034880881 | 응답 생성 시각 (UTC 기준) |
response | 배열 또는 null | 구역 정보가 포함된 데이터 객체 또는 없음(null) |
response 필드 상세 설명
필드명 | 예시 | 설명 |
workspaceId | null 또는 UUID | CUSTOM_ZONE 구역인 경우 UUID 형식으로 표시됩니다. |
zoneSection | JWC | 구역 유형: HRA, ECA, JWC, CUSTOM_ZONE, CUSTOM_PLACE_ZONE |
zoneName | Nigeria | 구역 이름입니다. |
latitude | 12.345678 | 구역 중심의 위도 좌표입니다. |
longitude | 98.765432 | 구역 중심의 경도 좌표입니다. |
radiusLength | 100 | 구역의 반지름 길이(m 단위)입니다. |
shapeType | POLYGON | 구역 도형의 형상입니다. (POLYGON, CIRCLE 등) |
properties | MTISC | 구역 관련 속성 정보입니다. |
geoData | GeoJSON 문자열 | 좌표 데이터 (GeoJSON 형식)입니다. |
enabled | true | 구역 활성화 여부입니다. |
응답 코드 목록
코드 | 설명 |
200 | 요청이 성공적으로 처리되었습니다. |
201 | 요청이 정상적으로 완료되었으며, 리소스가 생성되었습니다. |
400 | 파라미터가 잘못되었거나 형식이 유효하지 않습니다. |
401 | 인증이 필요합니다. |
403 | 접근 권한이 없습니다. |
422 | 서버가 요청을 이해했으나 처리할 수 없습니다. |
429 | 요청 횟수가 초과되었습니다. |