개요
FedEx는 Advanced Integrated Visibility 웹훅을 이용해 하나 이상의 FedEx 고객번호에 연결된 발송물의 실시간에 가까운 보안 배송 조회 이벤트 데이터를 목적 URL로 전달합니다. 웹훅 프로젝트를 생성해 FedEx Developer Portal을 통해 이 기능에 액세스할 수 있습니다.
이동 경로
다음 방법 중 하나를 통해 웹훅 생성 페이지에 접속할 수 있습니다.
- 내 프로젝트를 통한 경로: 왼쪽 탐색 패널 → 웹훅 탭 → +웹훅 프로젝트 생성
- API 카탈로그를 통한 경로:
- 왼쪽 탐색 패널 → API 카탈로그
- Advanced Integrated Visibility 검색 또는 필터링
- 개요 → 문서 클릭 → 샌드박스 콘솔에서 +프로젝트 생성 클릭
- 문서 → +웹훅 만들기 클릭
웹훅 생성 단계
1단계: 회사 유형 선택
+프로젝트 생성을 클릭하고 드롭다운에서 회사 유형을 선택합니다.
- 배송에 FedEx를 이용하고 있고, 회사 시스템에 FedEx 웹훅을 연동해야 합니다.
- FedEx 데이터를 사용하는 소프트웨어 솔루션을 판매하거나 제공하고 있으며, FedEx Compatible Provider가 아닙니다.
- 인증된 FedEx Compatible Provider입니다.
참고: 해당 옵션의 경우, 현재 FedEx Advanced Integrated Visibility 웹훅 솔루션을 이용할 수 없습니다. FedEx Compatible 프로그램의 일원으로서 Basic Integrated Visibility 또는 기타 FedEx 연동 솔루션을 이용하려면 채널 관리자에게 문의하세요. 담당 채널 관리자를 모르신다면, 회사 관리자에게 문의하세요.
그런 다음, 수신 등록 유형으로 Advanced Integrated Visibility 고객번호 수신 등록을 선택합니다.
Advanced Integrated Visibility 고객번호 수신 등록 생성하기
이 프로세스는 다음과 같이 4단계로 구성됩니다.
1단계: Advanced Integrated Visibility 고객번호 수신 등록 활성화
이 단계는 제3자 고객의 요청에 따라 FedEx 관리자 또는 FedEx 담당자가 관리합니다.
- MNDA 문서: FedEx 관리자 또는 FedEx 담당자는 당사자/배송업체 고객번호의 대량 목록과 함께 상호 기밀 유지 계약(MNDA)을 수집합니다.
참고: 이 업로드 과정에서는 다른 조직과 연관된 중복 고객번호도 허용됩니다.
- 해당하는 경우, 조직 수준에서 맞춤 요금이 활성화됩니다.
참고: 7월 경험에는 이 기능이 포함되지 않습니다.
2단계: + 프로젝트 생성
제품 선택 페이지에서 다음을 진행합니다.
- Advanced Integrated Visibility – 고객번호를 클릭하고 다음을 클릭합니다.
- 청구 고객번호를 선택하고 지불 조건에 동의한 후, 다음을 클릭합니다.
하나 이상의 청구 고객번호를 추가해야 합니다.
세부정보 확인 페이지에서 다음을 진행합니다.
- 프로젝트 정보를 검토하세요.
- 약관에 동의하세요.
- 맞춤 요금이 적용되는 경우, 관련 문서가 자동으로 나타납니다.
성공적으로 생성되면 다음과 같은 확인 메시지가 표시됩니다.
"'내 프로젝트'에 제품을 추가했습니다."
3단계: 프로젝트 개요 - API 키 활성화 프로세스
- API 프로젝트 개요 페이지의 APIs 섹션에서 API 키 탭을 확인하면 수신 등록의 프로덕션 상태가 초기에는 '비활성화됨'으로 표시됩니다.
- 요청 시 FedEx 관리자 또는 담당자가 제품을 활성화합니다.
- 활성화하면 프로덕션 키 탭에 액세스할 수 있으며, 프로덕션 상태가 '확인 대기 중'으로 업데이트됩니다.
- FedEx 관리자 또는 담당자가 최종 활성화를 완료하면 프로덕션 상태가 '활성화됨'으로 반영됩니다.
4단계: 프로젝트 개요 – 웹훅 구성
- 프로젝트 개요 페이지로 이동합니다.
- 웹훅 탭을 선택합니다.
- + 웹훅 구성 버튼을 클릭하면 웹훅 구성을 시작합니다. 웹훅 탭으로 이동합니다.
기능 설명
| 필드 이름 | 설명 |
|---|---|
| 배송 증명서 | 발송물이 성공적으로 배송되었음을 확인합니다. 다음 내용을 포함합니다. 배달 증명 사진(PPOD): 정확한 배송 위치를 보여주는 사진을 제공합니다. 배달 증명서 서명(SPOD): 수취인의 서명, 이름, 배송 날짜, 시간, 위치가 담긴 이미지를 제공합니다. |
| 예상 배송 날짜 | 수취인이 다음 정보를 통해 일정을 계획할 수 있도록 지원합니다. 배송 예정일(EDD) 배송 예정 시간 범위(EDTW) |
| 배송 조회 이벤트 | 알림을 받을 이벤트 카테고리를 하나 이상 선택할 수 있습니다. 발송 배송 중 배송 예외 맞춤 배송 옵션 |
| 이벤트 기반 필터링 | 웹훅 응답에 다음이 포함되도록 필터링합니다. 수입 발송물 수출 발송물 제3자 발송물 |
2. 세부정보 입력 페이지에서 다음 정보를 입력하세요.
| 필드 이름 | 설명 |
|---|---|
| 웹훅 프로젝트 이름 | 웹훅 프로젝트에 사용할 고유하고 비어 있지 않은 이름. 추천 이름이 자동으로 입력되지만, 편집할 수 있습니다. 이 이름은 다른 웹훅에서 중복 사용할 수 없습니다. |
| 목적 URL | FedEx가 배송 조회 이벤트 데이터를 전송할 보안 HTTPS 엔드포인트입니다. 요구 사항: 유효하고 정상 작동해야 합니다. 표준화된 구문을 준수해야 합니다. fedex.com 또는 그 하위 도메인을 포함하면 안 됩니다. 여러 웹훅에서 재사용할 수 있습니다. 자세한 내용은 비즈니스 규칙 및 모범 사례 섹션을 참고하세요. |
| 보안 토큰 | HMAC를 통해 웹훅 응답을 인증 및 검증하는 데 사용하기 위해 공유된 시크릿입니다. 요구 사항: 26~100자 대문자 1개, 소문자 1개, 숫자 1개 이상을 반드시 포함해야 합니다. 여러 웹훅에서 재사용할 수 있습니다. |
| 페이로드 언어(국가) | 드롭다운 목록에서 배송 조회 데이터를 번역할 언어를 선택합니다. |
| 배송 조회 유형 | 다음 중 배송 조회 데이터 제공 방법을 선택합니다. 자세한 배송 조회 – 전체 이벤트 내역 이벤트별 배송 조회 – 가장 최근 이벤트만 |
| 이메일 주소 | 알림을 받으려면 유효한 이메일 주소를 입력하세요. |
| 이메일 언어(국가) | 이메일 알림에 사용할 기본 언어를 선택합니다. 참고: 미국 로케일만 지원됩니다(예: en-US, es-US). |
3단계: 발송 고객번호 선택
발송 고객번호 선택 페이지에서 다음을 진행합니다.
웹훅 프로젝트에 연결할 FedEx 고객번호를 하나 이상 선택합니다.
중요 참고 사항:
다른 웹훅과 아직 연결되지 않은 고객번호만 표시됩니다.
계속 진행하려면 하나 이상의 고객번호를 연결해야 합니다.
웹훅 UI를 통해 추가할 수 있는 고객번호는 최대 100개입니다.
100개 이상의 고객번호를 연결하려면 웹훅 API를 사용하세요.
FedEx 고객지원팀 또는 헬프데스크에 연락하여 API 액세스를 요청하세요.
4단계: 세부정보 확인 및 생성
세부정보 확인 페이지에서 다음을 진행합니다.
1. 웹훅 프로젝트에 입력한 모든 정보를 검토하세요.
2. 약관에 동의하려면 체크박스를 선택합니다.
3. 생성을 클릭하여 웹훅 설정을 완료 처리합니다.
제출이 성공하면 시스템에서 생성한 수신 등록 ID를 가진 웹훅이 생성되며 활성 상태로 설정됩니다.
유효성 검사 규칙
일반 요구 사항:
웹훅 이름은 고유해야 합니다.
목적 URL은 표준화된 구문 형식을 따라야 합니다(보안 HTTPS를 사용해야 하며, fedex.com이나 그 하위 도메인은 사용할 수 없음).
모든 필수 필드를 작성해야 하며, 필수 필드는 비워 둘 수 없습니다.
웹훅에는 최소 1개의 유효한 FedEx 발송 고객번호가 연결되어 있어야 합니다.
유효성 검사 성공 시:
웹훅이 성공적으로 생성되면 고객에게 다음과 같은 확인 메시지가 전송됩니다.
<<Webhook name>>이(가) 생성되었습니다. 변경 사항이 적용되는 데 최대 10분이 소요될 수 있습니다.
유효성 검사 실패 시:
FedEx가 대상 URL로부터 HTTP 200(확인) 또는 202(수락) 외 다른 응답을 수신하면 웹훅 유효성 검사가 실패로 간주됩니다.
