Port API는 UNLOCODE, 항구명, 항구별칭을 기반으로
조건에 맞는 항구 정보를 검색할 수 있는 기능을 제공합니다.
요청 방식
•
HTTP Method : GET
•
API 경로 : /port
•
•
인증 방식 : Basic Auth
•
응답 포맷 : JSON
인증 방법
Swagger UI를 통해 Port API를 호출하려면 아래 절차를 따릅니다:
1.
Swagger 상단 우측의 [Authorize] 버튼 클릭
2.
팝업 창에 제공된 인증 정보(ID/PW) 입력
3.
다시 [Authorize] 클릭
4.
인증 완료 후 [Close] 클릭
인증 후 Swagger에서 호출되는 모든 요청에 인증 정보가 자동으로 포함됩니다.
항구 검색 방법
1. Swagger UI 실행 절차
1.
Swagger 문서의 Select a definition에서 Port 선택
2.
/port 경로로 이동
3.
[Try it Out] 클릭
4.
검색 키워드 입력
•
keyword 필드에 UNLOCODE, 항구명, 항구별칭 중 하나 입력
5.
[Execute] 클릭
6.
하단에서 응답 결과 확인
2. 요청 파라미터
파라미터명 | 필수 | 설명 |
keyword | | 항구명, UNLOCODE, 별칭 중 일부 또는 전체 키워드 입력 |
응답 정보
응답 예시
{
"code": 200,
"message": "OK",
"error": false,
"timestamp": "2024-12-01T12:00:00",
"response": [
{
"portId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"portName": "Busan",
"unlocode": "KRPUS",
"portAlias": "Busan",
"nationCode": "KR",
"latitude": 35.1796,
"longitude": 129.0756,
"timezone": "+09:00",
"geoData": "{\"type\":\"Polygon\",\"coordinates\":[126.491341,33.499621]}"
}
]
}
JSON
복사
응답 필드 설명
필드명 | 예시 | 설명 |
code | 200 | 응답 상태 코드 |
message | OK | 응답 메시지 |
error | false | 오류 여부 |
timestamp | 2024-12-01T12:00:00 | 응답 생성 시각 (UTC 기준) |
response | Object[] | 조건에 맞는 항구 데이터 목록 |
Depth 1 – 항구 정보 필드
필드명 | 예시 값 | 설명 |
portId | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | 내부 고유 항구 식별자 |
portName | Busan | 항구명 |
unlocode | KRPUS | UN 표준 항구 코드 |
portAlias | Busan | 항구 별칭 (다른 이름 또는 UNLOCODE 대체명) |
nationCode | KR | 국가 코드 (ISO-3166-1 alpha-2) |
latitude | 35.1796 | 위도 |
longitude | 129.0756 | 경도 |
timezone | +09:00 | 해당 항구의 시간대 |
geoData | { "type": "Polygon", "coordinates": [...] } | 항구 구역의 GeoJSON 데이터 |
응답 코드 안내
코드 | 설명 |
200 | 정상 처리 |
201 | 리소스 생성 |
400 | 잘못된 요청 |
401 | 인증 실패 |
403 | 권한 없음 |
422 | 처리 불가 |
429 | 호출 한도 초과 |