이 API는 특정 화물(Shipment)에 대해 요약 정보 및 이벤트 알림을 수신할 사용자를 등록합니다.
1. 인증 방법
Alert API는 사용자 인증을 위해 Swagger UI에서 Basic Authorize 인증 방식을 제공합니다.
인증 절차는 다음과 같습니다:
1.
우측 상단의 [Authorize] 버튼을 클릭합니다.
2.
팝업 창에 제공받은 인증 정보(아이디, 비밀번호)를 입력합니다.
3.
입력 후 다시 [Authorize] 버튼을 클릭하여 인증을 진행합니다.
4.
인증이 완료되면 [Close] 버튼을 클릭하여 인증 창을 닫습니다.
Swagger UI에서 호출되는 모든 API 요청에 인증 토큰이 자동으로 포함되어 전송됩니다.
2. 요청 정보
2-1. 요청 정보
Request URL : [POST] https://insight.seavantage.com/api/alert/cargo
2-2. 실행 순서
1.
2.
/alert/cargo 경로로 이동
3.
[Try it out] 클릭 → 입력창 활성화
4.
아래 요청 Parameters 조건에 따라 결과 반환
•
Request body : 각 화물별로 메일 수신자 2명을 지정 가능합니다.
Request body 예시
{
"documentId": "921ee5cc-fa1b-4ca8-912f-77f530f39239",
"sales": {
"email": "email@seavantage.com",
"isEventEmailEnabled": true
},
"operator": {
"email": "email@seavantage.com",
"isEventEmailEnabled": true
}
}
JavaScript
복사
필드 설명
◦
◦
sales
▪
email: 메일 수신 계정 (고객 워크스페이스에 등록된 계정만 이용 가능)
▪
isEventEmailEnabled:
•
true: Summary, 상태 변경 알람 함께 수신
•
false: Summary 메일만 수신
◦
operator
▪
email: 메일 수신 계정 (고객 워크스페이스에 등록된 계정만 이용 가능)
▪
isEventEmailEnabled:
•
true: Summary, 상태 변경 알람 함께 수신
•
false: Summary 메일만 수신
5.
[Execute] 버튼 클릭
6.
하단 응답 영역에서 등록 결과 확인
3. 응답 정보
요청이 성공하거나 실패했을 때 공통적으로 아래와 같은 형식으로 응답이 반환됩니다.
응답 예시
{
"code": 201,
"message": "Created",
"error": false,
"timestamp": "2025-08-27T11:06:57.205562372",
"response": null
}
JSON
복사
메일 수신 계정이나 상태 변경 알람 수신 여부를 수정하려면, 해당 값을 변경한 뒤 다시 호출하면 업데이트됩니다.
응답 필드 상세 설명
실패 시 응답 항목별 정의
필드명 | 예시 값 | 설명 |
code | 400 | 응답 상태 코드 (HTTP status code와 동일하게 사용됨)
(아래 별도 응답 상태 코드표 참조) |
message | Invalid request body. | 응답 메시지 (상태에 따른 설명) |
error | true | 오류 여부
true: 오류 발생
false: 정상 처리 |
timestamp | 2024-12-01T12:00:00 | 응답 생성 시각 (UTC 기준) |
응답 코드 종류코드 | 설명 |
201 | 정상 처리 (Created) |
400 | 잘못된 파라미터 (Bad Request) |
401 | 인증 필요 (Unauthorized) |
403 | 권한 없음 (Forbidden) |
422 | 처리 불가 (Unprocessable Entity) |
429 | 요청 과다 (Too Many Requests) |