IMO 번호와 선박명 정보를 기준으로 ship ID를 매칭합니다.
ship ID는 IMO 번호와 선박명이 모두 일치하는 경우에만 반환됩니다. 한 번의 API 호출로 최대 100척의 선박을 조회할 수 있습니다.
IMO 번호가 조회되지 않는 경우 결과값은 IMO_NO_NOT_FOUND로 반환됩니다. IMO 번호는 존재하지만 선박명이 일치하지 않는 경우 결과값은 SHIP_NAME_NOT_FOUND로 반환됩니다.
인증 방법
Ship API는 사용자 인증을 위해 Swagger UI에서 Basic Authorize 인증 방식을 제공합니다.
인증 절차는 다음과 같습니다:
1.
우측 상단의 [Authorize] 버튼을 클릭합니다.
2.
팝업 창에 제공받은 인증 정보(아이디, 비밀번호)를 입력합니다.
3.
입력 후 다시 [Authorize] 버튼을 클릭하여 인증을 진행합니다.
4.
인증이 완료되면 [Close] 버튼을 클릭하여 인증 창을 닫습니다.
Swagger UI에서 호출되는 모든 API 요청에 인증 토큰이 자동으로 포함되어 전송됩니다.
요청 정보
요청 정보
Request URL : [POST] https://insight.seavantage.com/api/ship/match
실행 순서
1.
2.
/ship/match 경로로 이동합니다.
3.
[Try it out] 버튼을 클릭하여 입력창을 활성화합니다.
4.
Request body를 입력합니다.
Request body 예시
[
{
"imoNo": "9330580",
"shipName": "DS OCEAN"
},
{
"imoNo": "9272682",
"shipName": "YC AZALEA"
}
]
JavaScript
복사
5.
[Execute] 버튼 클릭합니다.
6.
하단 응답 영역에서 등록 결과를 확인합니다.
응답 정보
요청이 성공하거나 실패했을 때 공통적으로 아래와 같은 형식으로 응답이 반환됩니다.
응답 예시
{
"code": 200,
"message": "OK",
"error": false,
"timestamp": "2026-06-25T07:46:21.992038394",
"response": [
{
"imoNo": "9330580",
"shipName": "DS OCEAN",
"shipId": null,
"result": "IMO_NO_NOT_FOUND"
},
{
"imoNo": "9272682",
"shipName": "YC AZALEA",
"shipId": "9f13225c-d649-4139-9c4c-c1b4c23641a6",
"result": "SUCCESS"
}
]
}
JavaScript
복사
응답 필드 상세 설명
응답 항목별 정의
필드명 | 예시 값 | 설명 |
code | 200 | 응답 상태 코드 (HTTP status code와 동일하게 사용됨)
(아래 별도 응답 상태 코드표 참조) |
message | success | 응답 메시지 (상태에 따른 설명) |
error | false | 오류 여부
true: 오류 발생
false: 정상 처리 |
timestamp | 2025-05-15T10:56:59.034880881 | 응답 생성 시각 (UTC 기준) |
response | 배열 또는 빈배열 | 선박 존재시 배열, 미존재시 빈배열 |
응답 코드 종류
코드 | 설명 |
200 | 정상 처리 (Success) |
400 | • 잘못된 파라미터 (Bad request)
• IMO번호 자릿수가 맞지 않는 경우 |
401 | 인증 필요 (Unauthorized) |
403 | 권한 없음 (Forbidden) |
422 | 처리 불가 (Unprocessable entity) |
429 | 요청 과다 (Too many requests, 분당 100회 초과 호출 시 발생) |
응답 상세 설명
Depth 1 필드 설명 (response 객체)
필드명 | 예시 값 | 설명 | 데이터 타입 |
imoNo | 9330587 | 선박 IMO 등록번호 | text |
shipName | DS OCEAN | 선명 | text |
shipId | 5687f61a-cfd2-4917-89f7-87e57c5c461c | SeaVantage 자체 선박 고유 아이디 | text |
result | SUCCESS | • SUCCESS : IMO 번호와 선박명이 모두 일치하는 경우
• IMO_NO_NOT_FOUND : IMO 번호가 조회되지 않는 경우
• SHIP_NAME_NOT_FOUND : IMO 번호는 존재하지만 선박명이 일치하지 않는 경우 | text |