Ship API를 사용하면 IMO 번호(7자리), MMSI 번호(9자리), 선박명을 입력하여
해당 선박의 기본 정보(선종, 건조년도, DWT 등)를 조회할 수 있습니다.
요청 방식
•
HTTP Method : GET
•
API 경로 : /ship/search
•
•
호출 주기 제한 : 없음
•
응답 포맷 : JSON
•
인증 방식 : Basic Auth
인증 방법
Swagger UI를 통해 API 호출 시 다음 절차를 따라 인증합니다.
1.
Swagger 상단 우측의 Authorize 버튼 클릭
2.
팝업 창에 제공받은 인증 정보 (ID, PW) 입력
3.
다시 Authorize 버튼 클릭하여 인증 진행
4.
인증 완료 후 Close 버튼으로 창 닫기
인증 완료 시 Swagger에서 실행되는 모든 API 요청은 자동으로 인증 토큰을 포함합니다.
선박 정보 조회하는 방법
1. 기본 조건
사용자는 아래 조건 중 하나로 조회를 요청합니다.
파라미터 | 설명 |
선박명 | 선박의 이름 (예: ARDMORE SEAVANTAGE) |
IMO | IMO 등록 번호 (7자리) |
MMSI | 해상 식별 번호 (9자리) |
•
keyword 필드에 하나를 입력
•
type 필드는 옵션값이며 기본값은 A
type 값 | 설명 |
A | Class A 선박 (대형 상선) |
B | Class B 선박 (소형 선박) |
2. Swagger UI에서 호출 실행
1.
[Try it out] 클릭
2.
keyword에 조회할 값 입력
3.
필요시 type에 A 또는 B 입력
4.
[Execute] 클릭
5.
하단 응답 확인
응답 정보
응답 형식 예시
{
"code": 200,
"message": "success",
"error": false,
"timestamp": "2025-05-15T10:56:59.034880881",
"response": [
{
"shipId": "aaa9dcf0-6af2-4f89-a6d5-c25594ed9837",
"imoNo": "9637076",
"mmsi": "538005248",
"callSign": "V7CD9",
"shipName": "ARDMORE SEAVANTAGE",
"shipType": "PRODUCT_TANKER",
"shipTypeBySize": "PRODUCT_TANKER01",
"nationCode": "MH",
"built": 2014,
"dwt": 49997
}
]
}
JSON
복사
주요 필드 설명
필드명 | 예시 | 설명 |
shipId | aaa9dcf0... | Seavantage 내부 선박 ID |
imoNo | 9637076 | IMO 번호 |
mmsi | 538005248 | MMSI 번호 |
callSign | V7CD9 | 호출부호 |
shipName | ARDMORE SEAVANTAGE | 선박명 |
shipType | PRODUCT_TANKER | 선박 타입 |
shipTypeBySize | PRODUCT_TANKER01 | 선박 타입 + 사이즈 |
nationCode | MH | 국적 코드 |
built | 2014 | 건조년도 |
dwt | 49997 | 총재화중량 (DWT) |
응답 코드 안내
코드 | 설명 |
200 | 정상 응답 |
201 | 리소스 생성 성공 |
400 | 잘못된 요청 파라미터 |
401 | 인증 실패 |
403 | 권한 없음 |
422 | 처리 불가 |
429 | 호출 제한 초과 |