1. 프로젝트를 생성해 자격 증명 받기
2. API 연동 및 구현 사항 테스트
3. 프로젝트를 프로덕션으로 이동
4. 인증 완료

조직의 Admin 또는 Contributor는 API 프로젝트 생성 버튼을 클릭해 API 프로젝트를 생성할 수 있습니다.

시작하기 전에 먼저 FedEx API에 액세스해야 하는 이유에 대해 설명하셔야 합니다. 메시지가 나타나고 드롭다운 옵션이 표시됩니다. 고객님께 FedEx 웹훅의 통합이 필요한 이유를 가장 잘 설명하는 옵션을 선택합니다.

발송인으로 확인되면 프로젝트 생성을 시작할 수 있습니다. 다음과 같은 3단계로 진행됩니다.

API 선택

프로젝트에 포함하려는 API를 선택합니다. 선택한 API에 따라 몇 가지 추가적인 선택을 해야 할 수 있습니다.

배송 조회 API를 선택한 경우 다음 작업도 함께 수행해야 합니다.

• 프로덕션 키에 연결할 고객번호를 선택합니다.
• 배송 조회 API 할당량, 속도 제한 및 API 인증 세부정보를 검토합니다.
• 트랜잭션 할당량이 초과된 경우 발송되는 이메일 알림의 수신 여부를 선택합니다.

프로젝트 구성

이름 및 발송 위치를 비롯해 일부 프로젝트 세부 정보를 입력합니다.

• 조직 내에서 고유하고 식별 가능한 이름을 프로젝트에 부여합니다.
• 발송물의 도착 국가를 선택하시면 테스트 발송 고객번호가 할당됩니다.유럽 국가 내에서 국내 발송 패키지를 테스트하려면 각 국가마다 별도의 테스트 고객번호가 있어야 합니다. 나중에 언제든 국가를 추가/제거할 수 있습니다.
• 최신 API 업데이트 및 서비스 중단과 관련된 모든 정보에 대한 알림을 받으려면 알림 환경설정을 설정합니다.

세부정보 확인

프로젝트 세부정보를 검토하고 약관에 동의해 주십시오.

• FedEx Developer Portal 사용권 계약을 읽고 동의하여 사용하려는 응용 프로그램을 판매 또는 배포할 의도가 없음을 밝혀야 합니다.
• "생성" 버튼을 클릭하면 확인 화면이 표시됩니다. 그런 다음 새 프로젝트에서 테스트 자격 증명을 볼 수 있습니다.

• 각 API 트랜잭션에서 사용해야 할 OAuth 액세스 토큰을 요청합니다. 토큰의 유효 시간은 한 시간이므로 세션이 만료되기 전에 토큰을 갱신하도록 응용 프로그램을 코딩해야 합니다. 자세한 내용은 API 인증 설명서를 참조하십시오.
• API 설명서를 클릭해 각 API의 비즈니스 영역을 읽으면 API 활용 방법을 이해하는 데 도움이 됩니다. 원하는 연동 방식과 맞는 엔드포인트의 예제 요청을 검토할 수도 있습니다.
• 예제 요청에 설명된 대로 해당 엔드포인트에 필요한 사항을 구현하고, 이를 테스트 자격 증명으로 구성합니다.
• 수신한 API 호출 응답이 설명서에 표시된 것과 일치하는지 확인합니다.
• 테스트 자격 증명과 FedEx 테스트 URL를 사용해 FedEx 테스트 환경 내에서 구현 사항을 테스트합니다.

프로젝트 구성 단계 시 수행 작업:

• 필요한 경우 키 이름을 변경할 수 있습니다.
• 프로젝트 생성 흐름 1단계에 선택한 고객번호를 검토합니다.이 고객번호는 프로젝트를 프로덕션으로 옮기는 데 사용됩니다.프로젝트가 프로덕션에서 활성화되면 필요에 따라 고객번호를 추가할 수 있습니다.

프로젝트 키 받기 단계 시 수행 작업:

• 프로덕션 API 키와 프로덕션 시크릿 키가 표시됩니다. 보안상 안전한 곳에 복사해두기 바랍니다.
• 프로덕션 시크릿 키는 보안을 위해 한 번만 표시됩니다. 잃어버린 경우에는 새 키를 생성할 수 있습니다.
• 다음을 클릭합니다.

프로젝트 개요 페이지로 이동하게 됩니다. 여기에서 프로젝트에 연결할 고객번호를 더 추가할 수 있습니다.

프로젝트 개요 페이지에서:

• 세로 쓰리닷(또는 케밥 메뉴)을 클릭해 프로젝트에 연결할 고객번호를 추가합니다.
• 그런 다음 편집을 클릭합니다.

그러면 해당 프로젝트의 프로덕션 키와 연결할 다른 고객번호를 추가할 수 있는 API 키 페이지로 이동하게 됩니다.

1. 일부 API는 프로덕션 환경에서 사용하기 위해 발송 라벨 인증이 필요합니다. 해당 요건에 맞게 프로젝트의 모든 API에 대해 인증 프로세스를 완료하십시오.

1. 모든 API가 인증되고 활성화되면 테스트 URI와 키, 발송 고객번호를 프로덕션 URI와 키, 발송 고객번호로 교체하여 API 요청을 업데이트합니다.

2. 샘플 데이터를 사용해 프로덕션 환경에서 구현 사항을 다시 테스트하십시오.

3. 이제 새로운 통합이 선사하는 혜택을 누리십시오!

웹훅 프로젝트 생성 전제 조건

1. 해당 응용 프로그램/플랫폼에 유효한 URL을 생성
2. 보안 토큰 생성
3. 웹훅 URL 테스트
4. 목적 URL 유효성 확인

웹훅 프로젝트 생성

1. 웹훅 프로젝트를 생성해 구성된 페이로드 알림 수신

웹훅 프로젝트 생성 전제 조건

목적 응용 프로그램/플랫폼에서 유효한 URL을 생성해 인증 코드/메시지를 수신하고 FedEx로부터 배송 조회 웹훅 페이로드 알림을 받을 수 있습니다.

URL 요구 사항:

이 보안 토큰을 사용자(고객)과 FedEx 간에 전송된 정보를 인증하고 검증하는 시크릿 키로 사용할 수 있습니다.

보안 토큰 요구 사항:

• 최소 25자에서 최대 100자 사이
• 대문자 1개 이상 포함
• 소문자 1개 이상 포함
• 숫자 1개

URL 테스트는 선택 사항으로, 유용하게 사용될 수 있습니다.

1단계에 생성한 URL의 유효성 여부를 판단하는 데 도움이 될 수 있습니다. 이를 통해 FedEx가 URL을 식별하고 해당 URL과의 연결을 구축해 데이터를 보낼 수 있습니다. 또한 응용 프로그램에 제공된 배송 조회 데이터를 처리할 수 있는지 확인하는 데 도움이 될 샘플 테스트 데이터를 제공할 수도 있습니다. 그러나 테스트 자체가 URL을 인증하는 것은 아닙니다.

웹훅 URL의 테스트 방법에 대해 알아보려면 웹훅 설명서를 참고하십시오.

HMAC SHA256 해싱 알고리즘 방법을 사용하여 목적 URL과 FedEx 간에 전송되는 정보를 검증하는 인증 프로세스를 설정합니다.

1. 생성을 클릭하면 FedEx가 생성한 임의의 챌린지 문자열이 요청 본문에서 사용자에게 전달됩니다.그러면 사용자는 응답 본문에서 FedEx에 이 챌린지 문자열을 반환합니다.

1. HMAC SHA256 알고리즘/절차에 따라 메시지 인증 코드(MAC)를 초기화해 해시 서명을 구성할 챌린지 문자열과 보안 토큰(또는 시크릿 키)을 해싱(또는 결합)합니다.

1. 응답 본문에 challengeString 및 challengeStringResponse를 사용하여 HTTP 상태 코드 200(확인) 또는 202(수락)으로 FedEx에 응답합니다.

1. FedEx는 이제 챌린지 문자열과 챌린지 문자열 응답의 유효성을 확인합니다.

• FedEx는 응답 본문을 수신한 후 challengeString과 challengeStringResponse(또는 이전에 생성된 해시 서명)를 FedEx에서 생성한 challengeString 및 해시 서명과 각각 비교해 유효성을 확인합니다.

• 두 "challengeString"과 HMAC 서명이 HMAC 서명이 모두 일치하면 유효성 확인 및 워크플로가 성공한 것입니다. 그렇지 않으면 유효성 확인 프로세스가 실패하고 이에 해당하는 오류 메시지가 표시됩니다.

웹훅 프로젝트 생성

내 프로젝트 페이지에서 웹훅 탭으로 이동합니다.

조직의 Admin 또는 Contributor는 웹훅 생성 프로젝트 버튼을 클릭해 웹훅 프로젝트를 생성할 수 있습니다.

시작하기 전에 먼저 FedEx 웹훅에 액세스해야 하는 이유에 대해 설명하셔야 합니다. 메시지가 나타나고 드롭다운 옵션이 표시됩니다. 고객님께 FedEx 웹훅 연동이 필요한 이유를 가장 잘 설명하는 옵션을 선택합니다.

발송인으로 확인된 경우 다음 단계를 통해 프로젝트 생성을 시작할 수 있습니다.

1. 비즈니스 필요 사항 확인

• 고객님께 FedEx 웹훅 연동이 필요한 이유를 가장 잘 설명하는 옵션을 선택합니다.

1. 티어 및 티어 기능 선택

• 프로젝트에서 필요로 하는 사항에 따라 기본 또는 고급 웹훅 티어 중에서 선택합니다.
• 나중에 언제든 티어 선택을 수정할 수 있습니다.
• 각 티어에는 월간 구독료가 적용됩니다.

• 프로젝트에 구성하려는 기능을 선택합니다.
• 나중에 기능을 수정할 수도 있습니다.

1. 프로젝트 세부정보

• 프로젝트에 고유한 이름을 지정합니다.
• 사전 설정 인증 시 미리 생성된 목적 URL 및 보안 토큰 세부정보를 입력합니다.

고객번호 선택

• 적격한(미국 또는 캐나다 기반) 고객번호 목록에서 프로젝트에 연결하려는 고객번호를 선택합니다.

  5. 세부정보 확인 및 약관 동의

• 구성된 프로젝트 세부정보를 검토합니다.
• Developer Portal 사용권 계약을 읽고 동의하여 사용하려는 응용 프로그램을 배포할 의도가 없음을 밝혀야 합니다.
• 요금 계약을 읽고 수락하십시오.
• 프로젝트 생성 버튼을 클릭한 후:

1. 생성 요청이 성공적으로 검증 및 처리되면 확인 화면으로 이동하게 됩니다.

• 유효성 검사에 통과하지 못하면 오류 메시지를 받게 됩니다.

1. 그러면 배송 조회 웹훅 프로젝트에 시스템에서 생성된 웹훅 ID가 부여되고 "활성" 상태로 표시됩니다.

1. FedEx가 호환 가능 제공자 조직을 생성합니다.
2. 초대를 수락합니다.
3. 귀하의 조직에 사용자를 초대합니다.
4. 귀하의 솔루션에 필요한 API를 선택합니다.
5. FedEx가 프로젝트를 생성합니다.
6. 응용 프로그램에 API를 통합하고 호환 가능한 프로그램을 인증합니다.
7. FedEx가 프로젝트를 프로덕션으로 이동시킵니다.
8. 프로덕션 시크릿 키를 생성합니다.

• FedEx에서 조직을 생성한 후 팀 멤버 한 명을 조직으로 초대합니다. 이 사용자가 조직의 Admin으로 지정됩니다.
• 인증과 통합이 완료되면 귀하는 고객들에게 손쉽게 솔루션을 배포할 수 있습니다.

• API 통합 결과물과 서류에 대한 접근 권한을 얻으려면 초대를 수락해주십시오. 초대를 수락하려면 FedEx 사용자 ID와 비밀번호로 로그인하거나, 기존 계정이 없다면 새 ID를 만듭니다.

• 관리자로서 프로젝트 또는 조직에 접근 권한이 필요한 다른 팀 멤버들을 초대할 수 있습니다. 다양한 역할에 대한 상세 정보는 조직 관리 가이드를 참조하십시오.

• 이미 생성된 조직이 있는 경우 조직의 관리자 또는 FedEx에 초대를 요청합니다. 24시간 내에 초대를 수락해야 하지만, 정해진 기한이 지나도 다시 초대를 보내도록 요청할 수 있습니다.

• API 카탈로그에서 응용 프로그램에 적합한 API를 선택합니다. FedEx 고객 기술 지원 컨설턴트(CTC) 및 Compatible Channel 매니저가 비즈니스 니즈에 따라 솔루션에 적합한 API 선택을 선택하도록 도와드릴 수 있습니다.

• API를 선택해 개요, 변경 기록 및 주요 기능을 살펴봅니다.

• API 문서를 참조해 요청 및 응답 요소, 선택한 프로그래밍 언어로 된 예제, 오류 개체 등에 대해 알아봅니다.

• Salesforce로 돌아가 PIW(Product Information Worksheet)를 작성하고 귀하의 솔루션에 추가를 원하는 API의 리스트를 작성하십시오.

PIW가 승인되면 FedEx가 귀하의 프로젝트를 생성합니다. 솔루션 각 버전은 FedEx Developer Portal 내 별도의 프로젝트를 가집니다. 사용자가 조직의 관리자가 아닐 경우에는 각 프로젝트 확인을 위해 초대가 필요합니다. 

이는 FedEx CTC 및 인증팀과 마찬가지로 FedEx 호환 가능 팀이 귀하 팀의 API에 대한 기술적 예시를 조직하는 경우에도 해당합니다. FedEx 팀은 귀하가 채택한 API의 버전에서 이용 가능한 새로운 특징 및 기능에 대해 논의합니다. 또한 API, API 테스트 및 API '인증*' 절차를 시작하기 위해 마쳐야 하는 모든 절차에 관한 기술적 문제를 해결합니다.

* 인증 – 프로그램 준수 요건을 충족하기 위해 FedEx 호환 가능 프로그램이 정의하는 절차입니다. 호환 가능 프로그램 인증은 모든 호환 가능 제공자가 발송인(고객)에게 FedEx 기술 및 서비스 표준이 정의하는 대로 FedEx 기술을 구현, 판매, 배포하는지 확인을 요구합니다.

1. 이제 귀하는 테스트 API 키 및 테스트 시크릿 키에 접근해 트랜잭션을 실행할 수 있습니다. 프로젝트 개요 페이지의 테스트 키 탭에서 검색하십시오.

1. 고객 키를 생성하려면 귀하의 각 프로젝트 API 섹션에서만 찾을 수 있는 자격 증명 등록 API를 사용해야 합니다.
2. 몇 개의 고객 키를 생성하고 나면 모든 API 트랜잭션에 사용되는 OAuth 접근 토큰을 요청하십시오. 토큰 세션은 한 시간 동안만 유효하므로 세션이 만료되기 전에 토큰을 갱신하도록 응용 프로그램을 코딩해야 합니다. 자세한 내용은 API 인증 설명서를 참조하십시오. 샘플 코드를 확인하면 샘플 드롭다운에서 '리셀러'가 선택되었는지 확인하십시오.

1. 테스트 키 페이지에서 API에 해당하는 설명서를 선택해 비즈니스 컨텍스트를 읽고 선택한 API를 어떻게 활용할 수 있는지 이해하십시오. 원하는 통합에 맞는 엔드포인트의 예제 요청을 검토합니다.
2. 예제 요청에 설명된 대로 해당 엔드포인트에 필요한 사항을 구현하고, 귀하의 테스트 자격 증명을 사용하도록 구성합니다.
3. 수신한 API 호출 응답이 설명서에 표시된 것과 일치하는지 확인합니다.
4. 테스트 자격 증명과 FedEx 테스트 URI를 사용해 FedEx 테스트 환경 내에서 구현 사항을 빠짐없이 테스트하십시오.
5. 솔루션을 전부 테스트하고 나면, 각 솔루션을 Salesforce에서 인증하십시오. 귀하의 인증이 승인되면 FedEx는 제출된 모든 내용을 완전히 검토하고 귀하에게 알립니다.

• 그 다음으로 귀하의 프로젝트를 프로덕션으로 이동시킵니다.
• 이제 프로젝트 개요 페이지의 프로덕션 키 탭에서 프로덕션 API 키를 확인할 수 있습니다.

• 시크릿 키 열에서 시크릿 키 생성 링크를 클릭해 프로덕션 시크릿 키를 생성해야 합니다.
• 이제 프로덕션 환경에서 샘플 데이터를 사용해 귀하의 구현을 다시 테스트 할 수 있습니다.
• 이제 새로운 통합이 선사하는 혜택을 누리십시오!