이 API는 특정 선적 대상을 다른 사용자에게 공유할 수 있는 전용 링크를 생성합니다.
Swagger 문서 바로가기인증 방법
Share API는 사용자 인증을 위해 Swagger UI에서 Basic Authorize 인증 방식을 제공합니다.
인증 절차는 다음과 같습니다:
1.
우측 상단의 [Authorize] 버튼을 클릭합니다.
2.
팝업 창에 제공받은 인증 정보(아이디, 비밀번호)를 입력합니다.
3.
입력 후 다시 [Authorize] 버튼을 클릭하여 인증을 진행합니다.
4.
인증이 완료되면 [Close] 버튼을 클릭하여 인증 창을 닫습니다.
Swagger UI에서 호출되는 모든 API 요청에 인증 토큰이 자동으로 포함되어 전송됩니다.
요청 정보
요청 정보
Request URL : [POST] https://insight.seavantage.com/api/share/links
2-2. 실행 순서
1.
Swagger 문서에서 우측 상단의 Select a definition 메뉴에서 Share 를 선택합니다.
2.
/share/links 경로로 이동합니다.
3.
[Try it out] 버튼을 클릭하여 입력창을 활성화합니다.
4.
아래 요청 Parameters 조건에 따라 결과가 반환됩니다.
Request body 예시
{
"targets": [
{
"targetType": "CONTAINER",
"targetIds": [
"MSKU1234567"
]
}
],
"receiverIds": [
"receiver@example.com"
]
}
JavaScript
복사
필드 설명
•
targets
◦
targetType : 선박 식별 유형
▪
CONTAINER : Container 번호
▪
MBL : M-B/L 번호
▪
BOOKING : Booking 번호
◦
targetIds : 선적 번호 (M-B/L 번호, Booking 번호, Container 번호 중 하나)
▪
선적 번호는 최대 10개까지 입력 가능
•
receiverIds : 공유 링크 수신 이메일
◦
수신 이메일은 최대 5개까지 입력 가능
5.
[Execute] 버튼을 클릭합니다.
6.
하단 응답 영역에서 등록 결과를 확인합니다.
7.
[GET] /cargo/search/past-track
응답 정보
요청이 성공하거나 실패했을 때 공통적으로 아래와 같은 형식으로 응답이 반환됩니다.
응답 예시
{
"code": 200,
"message": "OK",
"error": false,
"timestamp": "2026-03-19T10:15:30",
"response": {
"linkId": "AbCdEfGh12345678",
"shareUrl": "https://insight.seavantage.com/share/AbCdEfGh12345678",
"createdAt": "2026-03-19T10:15:30Z"
}
}
JavaScript
복사
응답 필드 상세 설명
응답 필드 정의
필드명 | 예시 값 | 설명 |
code | 200 | 응답 상태 코드 (HTTP status code와 동일하게 사용됨)
(아래 별도 응답 상태 코드표 참조) |
message | OK | 응답 메시지 (상태에 따른 설명) |
error | false | 오류 여부
true: 오류 발생
false: 정상 처리 |
timestamp | 2025-05-14T01:09:00.834665213 | 응답 생성 시각 (UTC 기준) |
response | null 또는 Object | 응답 본문 데이터
화물 존재시 데이터 객체, 미존재시 null |
응답 코드 종류
코드 | 설명 |
200 | 정상 처리 (Success) |
400 | 잘못된 파라미터 (Bad request) |
401 | 인증 필요 (Unauthorized) |
403 | 권한 없음 (Forbidden) |
422 | 처리 불가 (Unprocessable entity) |
429 | 요청 과다 (Too many requests) |
503 | 일시적 서버 문재 발생 (Authorization server is unavailable) |
응답 객체 상세 설명
Depth 1 필드 설명 (response 객체)
필드명 | 예시 값 | 설명 | 데이터 타입 |
linkId | AbCdEfGh12345678 | 생성된 공유 링크의 고유 ID | varchar(64) |
shareUrl | https://insight.seavantage.com/share/AbCdEfGh12345678 | 공유 링크 | text |
createdAt | 2026-03-19T10:15:30Z | 공유 링크 생성 시각 | timestamp |