七宝コネクター

ShippoのAPIとの統合

はじめに

Shippoは、USPS、DHL、FedExなどのキャリアを含むマルチキャリア配送APIとウェブアプリです。顧客は配送料金の取得、ラベルの印刷、国際文書の自動化、配送の追跡、返品の促進を行うことができます。

目的

このインテグレーションでは、TulipのHTTPコネクター機能を活用してShippoのAPIと統合し、出荷の作成、さまざまなキャリアからの料金の取得、最適な料金の選択、出荷ラベルの作成と印刷、出荷の追跡を自動化する方法を紹介します。これらはすべて、チューリップ・アプリケーションから実行できます。さまざまなユースケースに応じて、Tulipとの統合を活用することで、サプライチェーン・オペレーションをコントロールし、荷物の発送をリアルタイムで可視化することができます。

APIドキュメント

Shippo APIドキュメント

前提条件

Shippoのウェブサイトでアカウントを作成し、ShippoのAPIへのすべてのコールでAuthorizationヘッダーとして使用されるAPIトークンを生成してください。Shippoでは、テストトークンとライブトークンを生成することができます。テストトークンは、APIとのテストHTTPコールを行い、Tulipアプリケーションを設計するために活用することができます。アプリが準備できたら、トークンを切り替え、アプリを本番環境にデプロイして、出荷ラベルやトランザクションをリアルタイムで生成することができます。

チューリップ接続の詳細

Shippoとの接続を確立するために、TulipのHTTPコネクタは、以下の詳細で構成する必要があります。

1. クラウドコネクターホスト
2. ホスト：api.goshippo.com
3. ポート：443
4. TLS:はい
5. 認証ヘッダーとしてのShippoトークンは、Connector Function経由で渡すことができます。

コネクタ機能

出荷の作成

目的

1. このコネクタ関数は、ShippoのAPIにPOSTコールを行い、リクエストボディの一部である送信者の詳細、受信者の詳細、およびパッケージの詳細を使用して、新しい出荷を作成します。
2. 作成に成功すると、ShippoはJSONオブジェクトを返します。このJSONオブジェクトには、作成された貨物のステータスと、ユーザーが取引を開始するために利用できる、さまざまなベンダーのレートの選択肢が含まれています。ユーザーは適切なレートを選択し、レートIDをTulip変数に格納します。この変数は、トランザクションを作成する際に動的に渡され、対応するコネクター関数で出荷ラベルを生成します。

エンドポイント

1. エンドポイントへのHTTP POSTコール：https://api.goshippo.com:443/shipments/

認証ヘッダー

ShippoのAPIで認証するために、ShippoのHTTPトークンをリクエストヘッダに渡す必要があります。以下はその形式です。

認証 : ShippoToken ($ShippoToken$)

必須入力

リクエストボディに渡される入力パラメータは以下の通りです。

1. 送信者名、ストリート、シティ、ステート、郵便番号、国。
2. 受信者名、Street、City、State、Zip Code、Country
3. パッケージの寸法 - 長さ、幅、重さ

必要な出力エキストラクター

作成されたShipmentオブジェクトには多くの情報が返されますが、抽出すべき重要なフィールドを以下に示します。

1. ステータス：出荷が正常に作成されたかどうかを示します。
2. 出荷ID：作成されたShipmentの詳細を取得するために参照できます。
3. 料金オプション：ベンダーごとに異なる料金オプションを示すオブジェクトの配列。レートIDは、この貨物の実際のトランザクションを作成するために渡される、抽出される重要なキーです。

トランザクションの作成

目的

1. このコネクタ関数は、前のコネクタ関数で新規貨物の作成時に返されたさまざまなオプションからベンダーと最終レートを選択した後にトランザクションを作成します。
2. 決定した運賃に関連するIDをShippoのエンドポイントにPOST HTTPコールすることで、トランザクションが確立されます。成功すると、Shippoはトランザクションのステータス、トラッキングID、配送ラベル、トラッキングURLなどを含むJSONオブジェクトを返します。返された配送ラベルは、チューリップアプリから直接印刷することができます。

エンドポイント

1. エンドポイントへのHTTP POST呼び出し: https://api.goshippo.com:443/transactions/

認証ヘッダー

ShippoのAPIで認証するために、ShippoのHTTPトークンをリクエストヘッダに渡す必要があります。以下はその形式です。

認証 : ShippoToken ($ShippoToken$)

必須入力

リクエストボディに渡す入力パラメータは以下の通りです。

1. レートID：トランザクションを成功させるために選択したレートのIDを渡します。

必要な出力エキストラクター

作成されたShipmentオブジェクトには多くの情報が返されますが、抽出される重要なフィールドは以下のとおりです。

1. ステータス：トランザクションが正常に作成されたかどうかを示します。
2. トランザクションID：実行されたトランザクションの詳細を取得するために参照できます。
3. 追跡番号：貨物を追跡する
4. トラッキングURL選択したベンダーのトラッキングページURL
5. ラベルURL：配送ラベル：チューリップ・アプリケーションに埋め込んで印刷できます。