Shippo의 API와 통합
소개
Shippo는 USPS, DHL, FedEx 등의 운송업체가 포함된 다중 운송업체 배송 API 및 웹 앱입니다. 고객은 배송료를 확인하고, 라벨을 인쇄하고, 국제 문서를 자동화하고, 배송을 추적하고, 반품을 용이하게 할 수 있습니다.
목적
이 통합은 Tulip의 HTTP 커넥터 기능을 활용하여 Shippo의 API와 통합하여 배송 생성, 다양한 배송업체로부터 다양한 요금 조회, 최적의 요금 선택, 배송 추적 옵션과 함께 배송 라벨 생성 및 인쇄를 자동화하는 방법을 강조합니다. 이 모든 작업은 Tulip 애플리케이션에서 수행할 수 있습니다. 다양한 사용 사례에 따라 Tulip과의 통합을 활용하여 공급망 운영을 제어하고 패키지 배송에 대한 실시간 가시성을 확보할 수 있습니다.
API 문서
사전 요구 사항
Shippo 웹사이트에서 계정을 생성하고 Shippo API에 대한 모든 호출에서 인증 헤더로 사용될 API 토큰을 생성합니다. Shippo에서는 테스트 토큰과 라이브 토큰을 생성할 수 있습니다. 테스트 토큰을 활용하여 API로 테스트 HTTP 호출을 수행하고 Tulip 애플리케이션을 디자인할 수 있으며, 앱이 준비되면 토큰을 전환하고 앱을 프로덕션에 배포하여 실시간으로 배송 라벨, 트랜잭션을 생성할 수 있습니다.
Tulip 연결 세부 정보
Shippo와 연결을 설정하려면 Tulip의 HTTP 커넥터를 다음과 같은 세부 정보로 구성해야 합니다.
- 실행 중: 클라우드 커넥터 호스트
- 호스트 : api.goshippo.com
- 포트:443
- TLS:예
- 커넥터 함수를 통해 인증 헤더로 Shippo 토큰을 전달할 수 있습니다.
커넥터 기능
발송물 생성
목적
- 이 커넥터 함수는 발신자 세부 정보, 수신자 세부 정보 및 요청 본문의 일부인 패키지 세부 정보를 사용하여 Shippo의 API에 POST 호출을 수행하여 새 배송을 생성합니다.
- 성공적으로 생성되면 Shippo는 사용자가 거래를 진행하고 시작하는 데 활용할 수 있는 다양한 공급업체의 요금 선택과 함께 생성된 배송 상태가 포함된 JSON 객체를 반환합니다. 사용자는 적합한 요금을 선택하고, 해당 커넥터 함수에서 배송 레이블을 생성하기 위해 트랜잭션을 생성할 때 동적으로 전달되는 요금 ID를 Tulip 변수에 저장할 수 있습니다.
엔드포인트
- 엔드포인트에 대한 HTTP POST 호출: https://api.goshippo.com:443/shipments/
인증 헤더
Shippo의 API로 인증하려면 Shippo의 HTTP 토큰을 요청 헤더에 전달해야 합니다. 형식은 다음과 같습니다.
인증: ShippoToken ($ShippoToken$)
필수 입력
다음은 요청 본문에 전달되는 입력 매개변수(콘텐츠 유형이 JSON인 경우)입니다.
- 발신자 이름, 도로명, 도시, 주, 우편 번호, 국가.
- 받는 사람 이름, 도로명, 도시, 주, 우편번호, 국가
- 패키지의 치수 - 길이, 폭, 너비 및 무게
필수 출력 추출기
생성된 배송 개체에 대해 많은 정보가 반환되지만, 추출해야 할 중요한 필드는 다음과 같습니다.
- 상태: 배송이 성공적으로 생성되었는지 여부를 나타냅니다.
- 배송 ID: 생성된 배송의 세부 정보를 얻기 위해 참조할 수 있습니다.
- 요금 옵션: 여러 공급업체에서 제공하는 다양한 요금 옵션을 나타내는 객체 배열입니다. 요금 ID는 이 배송에 대한 실제 거래를 생성하기 위해 전달되는 다른 키 중에서 추출해야 하는 중요한 키입니다.
거래 생성
목적
- 이 커넥터 기능은 이전 커넥터 기능에서 새 배송을 생성할 때 반환된 여러 옵션 중에서 공급업체 및 최종 요금을 선택한 후 트랜잭션을 생성합니다.
- 성공적인 트랜잭션은 결정된 요금과 관련된 ID를 전달하여 Shippo의 엔드포인트에 POST HTTP 호출을 수행하여 설정됩니다. 호출이 성공하면 Shippo는 거래 상태, 추적 ID, 배송 레이블 및 기타 정보가 포함된 JSON 객체를 반환합니다. 반환된 배송 라벨은 Tulip 앱 자체에서 직접 인쇄할 수 있습니다.
엔드포인트
- 엔드포인트에 대한 HTTP POST 호출: https://api.goshippo.com:443/transactions/
인증 헤더
Shippo의 API로 인증하려면 Shippo의 HTTP 토큰을 요청 헤더에 전달해야 합니다. 형식은 다음과 같습니다.
인증: ShippoToken ($ShippoToken$)
필수 입력
다음은 요청 본문에서 JSON이 콘텐츠 유형인 경우 전달되는 입력 매개변수입니다.
- 요금 ID: 성공적인 거래를 생성하기 위해 진행하기로 선택한 요금의 ID를 전달합니다.
필수 출력 추출기
생성된 배송 개체에 대해 많은 정보가 반환되지만, 추출해야 하는 중요한 필드는 다음과 같습니다.
- 상태: 트랜잭션이 성공적으로 생성되었는지 여부를 나타냅니다.
- 트랜잭션 ID: 실행된 트랜잭션의 세부 정보를 얻기 위해 참조할 수 있습니다.
- 추적 번호: 배송을 추적하기 위한 번호
- 추적 URL: 선택한 공급업체의 추적 페이지 URL
- 레이블 URL: 인쇄를 위해 Tulip 애플리케이션에 삽입할 수 있는 배송 라벨입니다.