Advanced Integrated Visibility 활용 방법
Advanced Integrated Visibility 웹훅은 FedEx가 실시간에 가까운 배송 조회 업데이트를 안전한 방식으로 특정 URL에 전송할 수 있게 합니다. 이 업데이트는 한 개 이상의 FedEx 고객번호에 연결된 발송물에 대한 업데이트로, 이 기능을 이용하려면 Advanced Integrated Visibility 웹훅 프로젝트를 생성해야 합니다.
Advanced Integrated Visibility 페이지 액세스 방법
다음 두 가지 방식으로 Advanced Integrated Visibility 설정에 접근할 수 있습니다.
옵션 1: 내 프로젝트를 통해
1. 왼쪽 탐색 패널에서 내 프로젝트로 이동합니다.
2. 웹훅 탭을 클릭합니다.
3. +웹훅 프로젝트 생성을 선택합니다.
옵션 2: API 카탈로그를 통해
1. 왼쪽 탐색 패널에서 API 카탈로그를 선택합니다.
2. Advanced Integrated Visibility를 검색합니다.
3. 웹훅 필터를 사용해 올바른 카드를 찾습니다.
4. 카드에서:
- 개요를 클릭한 다음 문서 버튼을 누르고, +웹훅 프로젝트 생성을 선택합니다.
- 아니면 문서로 이동하여 +웹훅 프로젝트 생성을 클릭할 수도 있습니다.
1단계: 회사 유형 선택
+프로젝트 생성을 클릭하고 드롭다운에서 회사 유형을 선택합니다.
1. 배송에 FedEx를 이용하고 있고, 회사 시스템에 FedEx 웹훅을 연동해야 합니다.
2. FedEx 데이터를 사용하는 소프트웨어 솔루션을 판매하거나 제공하고 있으며, FedEx Compatible Provider가 아닙니다.
3. 인증된 FedEx Compatible Provider입니다.
그런 다음, 수신 등록 유형으로 Advanced Integrated Visibility 배송 조회 번호 수신 등록을 선택합니다.
Advanced Integrated Visibility 배송 조회 번호 수신 등록 생성
Advanced Integrated Visibility 배송 조회 번호 수신 등록을 설정해 한 개 이상의 FedEx 배송 조회 번호에 대해 실시간에 가까운 배송 조회 업데이트를 안전하게 받아볼 수 있습니다. 이 업데이트는 고객님이 특정한 URL로 전송됩니다.
수신 등록 생성 단계
이 프로세스는 다음과 같이 4단계로 구성됩니다.
1. 프로젝트 구성
2. 프로젝트 세부 정보 입력
3. 세부정보 확인 및 약관 동의
4. 배송 조회 번호 추가
단계별 지침
1. 웹훅 구성 페이지:
청구 고객번호 확인
귀하 조직의 기본 청구 고객번호가 표시됩니다.
변경 방법:
- 고객번호가 하나뿐인 경우, 조직에 청구 고객번호 추가를 클릭합니다.
- 고객번호가 여러 개인 경우, 다른 청구 고객번호 선택을 클릭합니다.
참고: 자세한 요금 정보는 Advanced Integrated Visibility 개요 페이지를 확인하세요.
2. 기능 선택
- 필요한 기능을 선택하세요.
- 다음을 클릭해 계속합니다.
팁: 각 기능에 대해 자세히 알아보려면 그 옆에 있는 도움말 아이콘(?)을 클릭하세요.
기능 설명
| 필드 이름 | 설명 |
|---|---|
| 배송 증명서 | 발송물이 성공적으로 배송되었음을 확인합니다. 여기에는 다음이 포함됩니다.
|
| 예상 배송 날짜 | 수취인이 미리 계획할 수 있도록 다음을 제공합니다.
|
| 배송 조회 이벤트 | 알림을 받을 이벤트 카테고리를 하나 이상 선택할 수 있습니다.
|
세부정보 입력 페이지에서 다음 정보를 입력하세요.
| 필드 이름 | 설명 |
|---|---|
| 웹훅 프로젝트 이름 | 웹훅 프로젝트에 사용할 고유하고 비어 있지 않은 이름이어야 합니다. 추천 이름이 자동으로 입력되지만, 편집할 수 있습니다. 이 이름은 다른 웹훅에서 중복 사용할 수 없습니다. |
| 목적 URL | FedEx가 배송 조회 이벤트 데이터를 전송할 보안 HTTPS 엔드포인트입니다. 필수 요건:
|
| 보안 토큰 | HMAC를 통해 웹훅 응답을 인증 및 검증하는 데 사용되는 공유된 시크릿입니다. 필수 요건:
|
| 페이로드 언어(국가) | 드롭다운 목록에서 배송 조회 데이터를 번역할 언어를 선택합니다. |
| 배송 조회 유형 | 배송 조회 데이터를 제공받을 방법을 선택합니다.
|
| 이메일 주소 | 알림을 받으려면 유효한 이메일 주소를 입력하세요. |
| 이메일 언어(국가) | 이메일 알림에 사용할 기본 언어를 선택합니다. 참고: 미국 로케일만 지원됩니다(예: en-US, es-US). |
3. 세부정보 확인 페이지에서 다음을 진행합니다.
- 웹훅 프로젝트의 세부정보를 검토하세요.
- 약관을 확인하고 동의해 주세요.
- 생성을 클릭해 웹훅 프로젝트 설정을 완료 처리합니다.
4. 요청이 성공적으로 제출되면 다음을 진행합니다.
- FedEx가 새로운 웹훅 프로젝트를 생성합니다.
- Advanced Integrated Visibility Tracking Number Subscription API에 대한 프로덕션 키를 받게 됩니다.
- 이 API를 사용해 배송 조회 번호를 프로젝트에 연결할 수 있습니다.
자세한 정보는 Advanced Integrated Visibility Tracking Number Subscription API 문서 페이지를 참조하세요.
웹훅에 배송 조회 번호를 추가하는 방법
Advanced Integrated Visibility Tracking Number Subscription API를 사용해 웹훅 수신 등록에 배송 조회 번호를 추가하려면 다음 단계를 따르세요.
단계별 과정 안내
1. 수신 등록 프로젝트 생성하기
· 이전 섹션의 단계를 사용하거나 시작하기 가이드를 참조하세요.
2. OAuth 토큰 생성하기
- API 호출을 하려면 OAuth 토큰이 필요합니다.
- Authorization API를 사용해 토큰을 생성하세요.
- 자세한 방법은 API 카탈로그 내 Authorization API 문서를 참조하세요.
3. API 문서 액세스
- 왼쪽 탐색 메뉴에서 프로젝트 세부정보를 클릭합니다.
- 프로덕션 키 탭에서 스크롤하여 Advanced Integrated Visibility Tracking Number Subscription API 문서를 찾습니다.
API 엔드포인트 개요
| 엔드포인트 | 목적 |
|---|---|
| 배송 조회 번호 연결 | 웹훅 수신 등록에서 배송 조회 번호를 추가하거나 제거합니다. 비동기식 작업으로, 응답으로 작업 ID를 전송합니다. |
| 배송 조회 번호 작업 세부정보 | 성공적으로 추가되거나 아직 처리 중인 배송 조회 번호 개수 등 특정 작업 ID에 대한 세부정보를 제공합니다. |
| 배송 조회 번호 작업 상태 | 현재 처리 중인 모든 작업의 요약을 반환합니다. |
2단계에서 생성된 OAuth 토큰과 배송 조회 번호 연결 엔드포인트를 사용해 웹훅에 배송 조회 번호를 추가하세요.
유효성 검사 규칙
- 웹훅 이름은 고유해야 합니다.
- 목적 URL은 표준화된 구문 형식이어야 합니다.
- 필수 필드는 모두 입력해야 합니다.
- 유효한 FedEx 발송 고객번호를 최소 한 개 이상 연결해야 합니다.
유효성 검사 결과
| 상태 | 세부정보 |
|---|---|
| 성공 | 다음과 같이 확인 메시지가 표시됩니다. “<>이(가) 생성되었습니다. 변경 사항이 적용되는 데 최대 10분이 소요될 수 있습니다." |
| 실패 | FedEx가 200(확인) 또는 202(수락) 외 다른 응답을 수신하면 웹훅 목적 URL 유효성 검사가 실패로 간주됩니다. |
Response