이 API는 터미널 기준의 이전 기항 월별 물동량 데이터를 반환합니다. AIS 데이터를 기반으로 평균 약 15분 단위로 업데이트됩니다.
1. 인증 방법
Port Insight Next Calling 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-insight/next-calling/monthly/terminals
2-2. 실행 순서
1.
2.
/port-insight/next-calling/monthly/terminals 경로로 이동
3.
[Try it out] 클릭 → 입력창 활성화
4.
아래 요청 Parameters 조건에 따라 결과 반환
•
portId (필수)
◦
SeaVantage에서 발급한 고유 항구 식별자(Port ID)
◦
[GET] /port API를 통해 Port ID 확인 가능
•
from (필수)
◦
조회 시작 연-월
◦
예 : 2025-01
•
to (필수)
◦
조회 종료 연-월
◦
예 : 2025-01
•
terminalIds (선택)
◦
조회 항구의 터미널 ID 리스트 필터
◦
[GET] /port/terminal API를 통해 terminal ID 확인 가능
◦
복수 입력 가능
•
nextCallingNationCode (필수) : 조회 시 다음 기항 국가 코드 필터
•
nextCallingPortId (선택)
◦
다음 기항지에 대한 portId 필터
◦
[GET] /port API를 통해 Port ID 확인 가능
•
nextCallingTerminalId (선택)
◦
다음 기항 터미널에 대한 terminalId 필터
◦
[GET] /port/terminal API를 통해 terminal ID 확인 가능
5.
[Execute] 버튼 클릭
6.
하단 응답 영역에서 등록 결과 확인
3. 응답 정보
요청이 성공하거나 실패했을 때 공통적으로 아래와 같은 형식으로 응답이 반환됩니다.
응답 예시
요청 시 입력한 파라미터 조건에 따라 응답 결과는 아래와 같습니다.
•
항구 및 다음 기항지의 nationCode 정보만 입력 시 → 입력된 국가의 선박수 및 월별 물동량 조회
•
다음 기항지의 nationCode + portId 입력 시 → 입력된 항구의 선박 수 및 월별 물동량 조회
•
다음 기항지의 nationCode + portId + terminalId 입력 시 → 입력된 터미널의 선박 수 및 월별 물동량 조회
조건별 요청 파라미터
요청 조건 | 설명 |
portId + from + to + nextCallingNationCode | 조회 대상 항구 기준 → 다음 기항 국가의 선박 수 및 월별 물동량 조회 |
portId + from + to + terminalIds + nextCallingNationCode | 조회 대상 항구의 상세 터미널 기준 → 다음 기항 국가의 선박 수 및 월별 물동량 조회 |
portId + from + to + nextCallingNationCode + nextCallingPortId | 조회 대상 항구 기준 → 다음 기항 항구의 선박 수 및 월별 물동량 조회 |
portId + from + to + terminalIds + nextCallingNationCode + nextCallingPortId | 조회 대상 항구의 상세 터미널 기준 → 다음 기항 항구의 선박 수 및 월별 물동량 조회 |
portId + from + to + nextCallingNationCode + nextCallingPortId + nextCallingTerminalId | 조회 대상 항구 기준 → 다음 기항 터미널의 선박 수 및 월별 물동량 조회 |
portId + from + to + terminalIds nextCallingNationCode + nextCallingPortId + nextCallingTerminalId | 조회 대상 항구의 상세 터미널 기준 → 다음 기항 터미널의 선박 수 및 월별 물동량 조회 |
응답구조 (공통)
{
"code": 200,
"message": "OK",
"error": false,
"timestamp": "2025-08-20T07:20:58.866535036",
"response": [
{
"yearMonth": "2025-01",
"shipCount": 633,
"volume": 7404170
}
]
}
JavaScript
복사
응답 필드 상세 설명
응답 항목별 정의
필드명 | 예시 값 | 설명 |
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 객체)
필드명 | 예시 값 | 설명 | 데이터 타입 |
yearMonth | 2025-01 | 연-월 | varchar(7) |
shipCount | 10 | 선박 수 | integer |
volume | 10 | 물동량 (단위 : dwt) | integer |