Port Insight Statistics API는 지정된 기간 동안 특정 항만에 속한 터미널의 통계 정보를 제공합니다.
대기 시간, 작업 시간, 입출항 선박 수 등의 운영 지표를 통해 항만의 혼잡도를 분석할 수 있습니다.
요청 방식
•
HTTP Method : GET
•
API 경로 : /port-insight/statistics/terminals
•
응답 포맷 : JSON
•
인증 방식 : Basic Auth
인증 방법
Swagger UI를 통해 Port Insight API를 호출할 경우 다음 절차로 인증을 수행합니다:
1.
Swagger 우측 상단 [Authorize] 클릭
2.
팝업창에 제공받은 인증 정보 (ID, PW) 입력
3.
[Authorize] 버튼 재클릭
4.
인증 성공 후 [Close] 클릭
인증 완료 후에는 Swagger에서 실행되는 모든 API 호출에 인증 토큰이 자동 포함됩니다.
터미널 통계 조회 방법
1. Swagger UI 호출 절차
1.
Swagger 문서에서 Port Insight 선택
2.
/port-insight/statistics/terminals 항목으로 이동
3.
[Try it Out] 클릭
4.
아래 파라미터 입력
5.
[Execute] 클릭
6.
하단 응답 확인
2. 요청 파라미터
파라미터명 | 타입 | 설명 |
portId | string | Seavantage 고유 항구 식별자 |
from | string (UTC) | 조회 시작 시간 (YYYY-MM-DDTHH:mm:ss) |
to | string (UTC) | 조회 종료 시간 (YYYY-MM-DDTHH:mm:ss) |
terminalIds | array | Seavantage 고유 터미널 ID 목록 |
응답 정보
응답 예시
{
"code": 200,
"message": "OK",
"error": false,
"timestamp": "2024-12-01T12:00:00",
"response": [
{
"localAggregationTime": "2025-01-01T00:00:00Z",
"aggregationTime": "2025-01-01T00:00:00Z",
"onTheWayCount": 10,
"waitingCount": 10,
"workingCount": 10,
"avgStopHour": 12.3456,
"avgWaitingHour": 12.3456,
"avgWorkingHour": 12.3456,
"arrivalCount": 10,
"berthingCount": 10,
"departureCount": 10
}
]
}
JSON
복사
응답 필드 상세 설명
필드명 | 예시 값 | 설명 |
code | 200 | 응답 상태 코드 |
message | OK | 응답 메시지 |
error | false | 오류 여부 (true: 오류, false: 정상 처리) |
timestamp | 2024-12-01T12:00:00 | 응답 생성 시각 (UTC 기준) |
response | Object[] | 통계 결과 배열 (날짜별 또는 터미널별) |
Depth 1 – 응답 객체 필드
필드명 | 예시 값 | 설명 |
localAggregationTime | 2025-01-01T00:00:00Z | 집계 시각 (Local Time 기준) |
aggregationTime | 2025-01-01T00:00:00Z | 집계 시각 (UTC 기준) |
onTheWayCount | 10 | 항구를 향해 항해 중인 선박 수 |
waitingCount | 10 | 접안 대기 중인 선박 수 |
workingCount | 10 | 현재 작업(하역) 중인 선박 수 |
avgStopHour | 12.3456 | 항만 외곽에서 대기한 평균 시간 |
avgWaitingHour | 12.3456 | 대기 영역에서의 평균 대기 시간 |
avgWorkingHour | 12.3456 | 평균 작업 시간 |
arrivalCount | 10 | 24시간 내 입항 선박 수 |
berthingCount | 10 | 24시간 내 접안 선박 수 |
departureCount | 10 | 24시간 내 출항 선박 수 |
응답 코드 종류
코드 | 설명 |
200 | 정상 처리 |
201 | 리소스 생성 |
400 | 잘못된 요청 파라미터 |
401 | 인증 실패 |
403 | 권한 없음 |
422 | 처리 불가 |
429 | 호출 한도 초과 |