1. API 소개
이 API는 Port Insight 서비스가 제공되는 모든 항구에 대해 조회하는 기능을 제공합니다.
2. 인증 방법
Port API는 사용자 인증을 위해 Swagger UI에서 Basic Authorize 인증 방식을 제공합니다.
인증 절차는 다음과 같습니다:
1.
우측 상단의 [Authorize] 버튼을 클릭합니다.
2.
팝업 창에 제공받은 인증 정보(아이디, 비밀번호)를 입력합니다.
3.
입력 후 다시 [Authorize] 버튼을 클릭하여 인증을 진행합니다.
4.
인증이 완료되면 [Close] 버튼을 클릭하여 인증 창을 닫습니다.
Swagger UI에서 호출되는 모든 API 요청에 인증 토큰이 자동으로 포함되어 전송됩니다.
3. 요청 정보
3-1. 요청 정보
Request URL : [GET] https://insight.seavantage.com/api/port/all
3-2. 실행 순서
1.
Swagger 문서에서 우측 상단의 Select a definition 메뉴에서 Port 선택
2.
/port/all 경로로 이동
3.
[Try it Out] 클릭 → 입력창 활성화
4.
[Execute] 버튼 클릭
5.
하단 응답 영역에서 등록 결과 확인
4. 응답 정보
응답 예시{
"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
}
]
}
JavaScript
복사
응답 필드 상세 설명필드명 (Attr) | 예시 값 (Example) | 설명 (Desc) |
code | 200 | 응답 상태 코드 (HTTP status code와 동일하게 사용됨)코드 목록은 아래 참조 |
message | success | 응답 메시지 (상태에 따른 설명) |
error | false | 오류 여부
(true: 오류 발생, false: 정상 처리) |
timestamp | 2025-02-26T10:08:10.005543 | 응답 생성 시각 (UTC 기준) |
응답 코드 종류 (code 필드 기준)코드 | 설명 |
201 | 정상 처리 (Created) |
400 | 잘못된 파라미터 (Bad Request) |
401 | 인증 필요 (Unauthorized) |
403 | 권한 없음 (Forbidden) |
422 | 처리 불가 (Unprocessable Entity) |
429 | 요청 과다 (Too Many Requests) |
Depth 1 필드 설명 (response 객체)Attr | Example | Desc |
workspaceId | null | 기본적으로 null로 표시하며, CUSTOM_ZONE인 경우 UUID 형식으로 표시 |
zoneSection | JWC | HRA = 고위험 구역ECA = 배출 규제 지역JWC= 전쟁 위험 지역CUSTOM_ZONE = 사용자 정의 영역CUSTOM_PLACE_ZONE |
zoneName | Nigeria | |
latitude | 12.345678 | 위도 |
longitude | 98.765432 | 경도 |
radiusLength | 100 | 영역 지름 |
shapeType | POLYGON | zone의 형태 |
properties | 2 | |
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 |
enabled | true | zone 유효 여부 |