이 API는 UNLOCODE, 항구명, 항구별칭을 이용하여 항구(Port)를 검색하는 기능을 제공합니다. 사용자는 항구 이름의 일부 또는 전체 키워드를 입력하여 조건에 맞는 항구 정보를 조회할 수 있습니다.
1. 인증 방법
Port 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/port
2-2. 실행 순서
1.
2.
/port 경로로 이동
3.
[Try it out] 클릭 → 입력창 활성화
4.
아래 요청 Parameters 조건에 따라 결과 반환
•
keyword : UNLOCODE, 항구명, 항구별칭
5.
[Execute] 버튼 클릭
6.
하단 응답 영역에서 등록 결과 확인
3. 응답 정보
요청이 성공하거나 실패했을 때 공통적으로 아래와 같은 형식으로 응답이 반환됩니다.
응답 예시
{
"code": 200,
"message": "OK",
"error": false,
"timestamp": "2024-12-01T12:00:00",
"response": [
{
"portId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"portName": "Busan",
"unlocode": "KRPUS",
"nationCode": "KR",
"latitude": 35.1796,
"longitude": 129.0756,
"timezone": "+09:00",
"geoData": "{\"type\":\"Polygon\",\"coordinates\":[126.491341,33.499621]}"
}
]
}
JSON
복사
입력 필드 상세 설명
응답 항목별 정의
필드명 | 예시 값 | 설명 |
code | 200 | 응답 상태 코드 (HTTP status code와 동일하게 사용됨)
(아래 별도 응답 코드표 참조) |
message | "OK" | 응답 메시지 (상태에 따른 설명) |
error | false | 오류 여부
(true: 오류 발생, false: 정상 처리) |
timestamp | "2025-05-14T01:09:00.834665213" | 응답 생성 시각 (UTC 기준) |
response | 배열 또는 빈배열 | 데이터 존재시 배열, 미존재 시 빈배열 |
응답 코드 종류
코드 | 설명 |
200 | 정상 처리 (Success) |
400 | 잘못된 파라미터 (Bad Request) |
401 | 인증 필요 (Unauthorized) |
403 | 권한 없음 (Forbidden) |
422 | 처리 불가 (Unprocessable Entity) |
429 | 요청 과다 (Too Many Requests) |
응답 상세 설명
Depth 1 필드 설명 (response 객체)
필드명 | 예시 값 | 설명 | 데이터 타입 |
portId | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | 내부적으로 사용하는 port 구분 값 | varchar(36) - UUID |
portName | Busan | 항구명 | varchar(255) |
unlocode | KRPUS | 항구 UNLOCODE | varchar(36 |
nationCode | KR | 국가 코드 | varchar(36) |
latitude | 35.1796 | 위도 | double precision |
longitude | 129.0756 | 경도 | double precision |
timezone | +09:00 | 항구 타임존 | varchar(36) |
geoData | {\"type\":\"Polygon\",\"coordinates\":[126.491341,33.499621]} | 항구 구역 GeoData | text |