Port Insight에서 제공하는 항구 및 터미널에 대한 일반 정보를 조회할 수 있는 API입니다.
인증 방법
Port API는 사용자 인증을 위해 Swagger UI에서 Basic Authorize 인증 방식을 제공합니다.
인증 절차는 다음과 같습니다:
1.
우측 상단의 [Authorize] 버튼을 클릭합니다.
2.
팝업 창에 제공받은 인증 정보(아이디, 비밀번호)를 입력합니다.
3.
입력 후 다시 [Authorize] 버튼을 클릭하여 인증을 진행합니다.
4.
인증이 완료되면 [Close] 버튼을 클릭하여 인증 창을 닫습니다.
Swagger UI에서 호출되는 모든 API 요청에 인증 토큰이 자동으로 포함되어 전송됩니다.
요청 정보
요청 정보
Request URL : [GET] https://insight.seavantage.com/api/port-insight
실행 순서
1.
2.
/port-insight 경로로 이동합니다.
3.
[Try it out] 버튼을 클릭하여 입력창을 활성화합니다.
4.
아래 요청 Parameters 조건에 따라 입력합니다.
•
portId : SeaVantage에서 발급한 고유 항구 식별자(Port ID)
5.
[Execute] 버튼 클릭합니다.
6.
응답 영역에서 등록 결과를 확인합니다.
해당 API는 조회 대상 항구에 대해 서비스 권한이 설정되지 않은 경우, 해당 항구의 정보는 조회하실 수 없습니다. 권한 요청은 cx@seavantage.com으로 문의해 주세요.
응답 정보
요청이 성공하거나 실패했을 때 공통적으로 아래와 같은 형식으로 응답이 반환됩니다.
응답 예시
{
"code": 200,
"message": "OK",
"error": false,
"timestamp": "2024-12-01T12:00:00",
"response": {
"port": {
"portId": "123e4567-e89b-12d3-a456-123456789012",
"portName": "Busan",
"unlocode": "KRPUS",
"nationCode": "KR",
"latitude": 12.3456,
"longitude": 12.3456,
"timezone": "+09:00",
"geoData": "{\\\"type\\\":\\\"MultiPolygon\\\",\\\"coordinates\\\":[[[[128.833127307,35.039946938],\n[128.778530218,35.039998445]]]]}\"\n"
},
"terminals": [
{
"terminalId": "47941f60-13b8-4718-bead-aa7c3c61d530",
"terminalName": "BUSAN CONTAINER TERMINAL (BCT)"
}
]
}
}
JavaScript
복사
응답 필드 상세 설명
응답 항목별 정의
필드명 | 예시 값 | 설명 |
code | 200 | 응답 상태 코드 (HTTP status code와 동일하게 사용됨)
(아래 별도 응답 상태 코드표 참조) |
message | OK | 응답 메시지 (상태에 따른 설명) |
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 필드 설명 (port 객체)
필드명 | 예시 값 | 설명 | 데이터 타입 |
portId | 123e4567-e89b-12d3-a456-123456789012 | 내부적으로 사용하는 Port 구분 값 | varchar(36) - UUID |
portName | Busan | 항구명 | varchar(255) |
unlocode | KRPUS | 항구 UNLOCODE | varchar(36) |
nationCode | KR | 국가 코드 | varchar(36) |
latitude | 12.3456 | 위도 | double precision |
longitude | 12.3456 | 경도 | double precision |
timezone | +09:00 | 항구 타임존 | |
geoData | {\\\"type\\\":\\\"MultiPolygon\\\",\\\"coordinates\\\":[[[[128.833127307,35.039946938],\n[128.778530218,35.039998445]]]]}\"\n"
} | 항구 구역 GeoData |
Depth 2 필드 설명 (terminals 객체)
필드명 | 예시 값 | 설명 | 데이터 타입 |
terminalId | f66c027a-08d8-11ed-b938-049226dae5ce | 내부적으로 사용하는 Terminal 구분 값 | varchar(36) - UUID |
terminalName | BUSAN CONTAINER TERMINAL (BCT) | 터미널명 | varchar(128) |