지정한 기간 동안 특정 항만(port)에 속한 터미널의 통계 정보를 반환하는 API입니다. 제공되는 통계에는 항구로 이동 중인 선박 수, 접안 대기 선박 수, 접안 중인 선박 수, 평균 대기 시간, 평균 작업 시간, 도착 선박 수, 출항 선박 수가 포함됩니다.
인증 방법
Port Insight Statistics 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/statistics/terminals
실행 순서
1.
2.
/port-insight/statistics/terminals 경로로 이동합니다.
3.
[Try it out] 버튼을 클릭하여 입력창을 활성화합니다.
4.
아래 요청 Parameters 조건에 따라 결과가 반환됩니다.
•
•
from
◦
조회 시작 일시 (UTC 기준)
◦
예 : 2025-01-01T00:00:00Z
•
to
◦
조회 종료 일시 (UTC 기준)
◦
예 : 2025-01-01T00:00:00Z
•
5.
[Execute] 버튼 클릭합니다.
6.
응답 영역에서 등록 결과를 확인합니다.
응답 정보
요청이 성공하거나 실패했을 때 공통적으로 아래와 같은 형식으로 응답이 반환됩니다.
응답 예시
{
"code": 200,
"message": "OK",
"error": false,
"timestamp": "2024-12-01T12:00:00",
"response": [
{
"localAggregatedAt": "2025-01-01T00:00:00Z",
"aggregatedAt": "2025-01-01T00:00:00Z",
"onTheWayCount": 10.0,
"waitingCount": 10.0,
"workingCount": 10.0,
"avgStopHour": 12.3456,
"avgWaitingHour": 12.3456,
"avgWorkingHour": 12.3456,
"arrivalCount": 10.0,
"berthingCount": 10.0,
"departureCount": 10.0
}
]
}
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 객체)
필드명 | 예시 값 | 설명 | 데이터 타입 |
localAggregatedAt | 2025-01-01T11:30:00Z | 통계 집계 시각(항구 local time 기준) | timestamp |
aggregatedAt | 2025-01-01T02:30:00Z | 통계 집계 시각(UTC 기준) | timestamp |
onTheWayCount | 10.0 | 데이터 생성 시점 항구로 이동중인 선박 수 | real |
waitingCount | 10.0 | 데이터 생성 시점 항구 접안 대기중인 선박 수 | real |
workingCount | 10.0 | 데이터 생성 시점 항구 접안 선박 수 | real |
avgStopHour | 12.3456 | 대기 영역 바깥쪽에서 발생하는 평균 대기 시간 | real |
avgWaitingHour | 12.3456 | 대기 영역에서 발생하는 평균 대기 시간 | real |
avgWorkingHour | 12.3456 | 평균 작업 시간 | real |
arrivalCount | 10.0 | 24시간 내 도착 선박 수 | real |
berthingCount | 10.0 | 24시간 내 접안 선박 수 | real |
departureCount | 10.0 | 24시간 내 출항 선박 수 | real |