Fleet API는 조회 대상 선박을 등록하고, 특정 카테고리(categoryId)에 선박을 매핑할 수 있도록 지원합니다.
복수의 shipId 등록도 가능하며, 별도 카테고리 관리 기능도 포함되어 있습니다.
인증 방법
Fleet API는 사용자 인증을 위해 Swagger UI에서 Basic Authorize 인증 방식을 사용합니다.
1.
Swagger 우측 상단 [Authorize] 클릭
2.
팝업에 제공받은 ID / PW 입력
3.
다시 [Authorize] 클릭
4.
인증 완료 후 [Close] 클릭
인증 완료 시 모든 API 요청에 인증 정보가 자동 포함됩니다.
선박 등록 방법
1. 요청 조건
파라미터명 | 설명 |
categoryId | 카테고리 UUID. 입력하지 않으면 기본 카테고리에 자동 매핑됩니다. (예: 123e4567-e89b-12d3-a456-426614174000) |
shipId | 등록할 선박 UUID. 복수 등록 가능. (예: aaa9dcf0-6af2-4f89-a6d5-c25594ed9837) |
※ 추가적인 카테고리 발급은 sales@seavantage.com으로 요청 주세요.
2. Swagger UI 실행 순서
1.
Swagger 정의 항목에서 Fleet 선택
2.
/fleet 경로로 이동
3.
[Try it Out] 클릭
4.
categoryId, Request Body 입력
5.
[Execute] 클릭
6.
하단에서 응답 확인
3-3. 등록 요청 Request Body 예시
[
"aaa9dcf0-6af2-4f89-a6d5-c25594ed9837",
"aaa9dcf0-6af2-4f89-a6d5-c25594ed9837"
]
JSON
복사
응답 정보
응답 예시
{
"code": 200,
"message": "OK",
"error": false,
"timestamp": "2024-12-01T12:00:00",
"response": {}
}
JSON
복사
응답 필드 설명
필드명 | 예시 값 | 설명 |
code | 200 | 응답 상태 코드 |
message | OK | 처리 결과 메시지 |
error | false | 오류 여부 |
timestamp | 2025-05-15T10:56:59.034880881 | 응답 생성 시각 (UTC 기준) |
response | {} | 응답 본문 (기본적으로 빈 객체) |
응답 코드 안내
코드 | 설명 |
200 | 정상 처리 |
201 | 리소스 생성 |
400 | 잘못된 파라미터 |
401 | 인증 필요 |
403 | 권한 없음 |
422 | 처리 불가 (예: 유효하지 않은 shipId) |
429 | 요청 과다 (Rate Limit 초과) |