Webhookに追跡番号をを追加する方法
「Advanced Integrated Visibility Tracking Number Subscription API」を使用して、Webhookサブスクリプションに追跡番号を追加するには、以下の手順に従ってください。
- 前のセクションで説明したステップに従って、あるいは入門ガイドに記載されたステップで、Advanced Integrated Visibility追跡番号に基づくサブスクリプションプロジェクトを構築します。
- Advanced Integrated Visibility Tracking Number Subscription APIを呼び出すには、OAuthトークンが必要です。OAUTHトークンを生成するには、Authorization APIを使用してください。OAUTHトークンを生成する詳細なステップについては、APIカタログ内のAuthorization APIドキュメントを参照してください。
- 左側のナビゲーションメニューから「プロジェクト詳細」オプションをクリックしてください。[プロダクションキー] タブで、[Advanced Integrated Visibility Tracking Number Subscription API]のドキュメントまでスクロールダウンします。
Advanced Integrated Visibility Tracking Number Subscription APIのドキュメントにアクセスすると、3つのエンドポイントが表示されます。
Track Number Association End point
- このエンドポイントを使用して、指定されたWebhookサブスクリプションに追跡番号を追加または削除します。詳細については、Advanced Integrated Visibility Tracking Number Subscription APIのドキュメントをご覧ください。
- 追跡番号の追加または削除は、非同期処理されます。ジョブIDは、追跡番号の関連付けを追加または削除するAPI呼び出しに対する応答として送信されます。
Track Number Job Details End point
このエンドポイントでは、指定されたジョブIDに関する詳細情報を提供します。例えば、送信されたすべての追跡番号のうち、指定されたWebhookサブスクリプションに正常に追加された件数や、まだ処理中の件数などが含まれます。
Track Number Job Status End point
このエンドポイントを使用すると、現在処理中のすべてのジョブの現在の概要を取得できます。
- ステップ2で生成されたAUTHトークンを、Track Number Associationエンドポイントで使用して、Webhookサブスクリプションに追跡番号を追加します。
検証ルール:
- Webhook名は一意でなければなりません。
- Webhookのリンク先URLは、標準化された構文形式でなければなりません。
- Webhookの作成に必要なすべてのフィールドを空フィールドにすることはできません。
- Webhookを作成するには、少なくとも1つの利用可能なFedEx出荷アカウント・ナンバーを関連付ける必要があります。
- 検証を成功させるには:
- Webhookが正常に作成されると、顧客は確定メッセージを受け取ります。
確定メッセージのサンプル:<>が正常に作成されました。ただし、変更が有効になるまでに最大10分かかることがあります。
- Webhookが正常に作成されると、顧客は確定メッセージを受け取ります。
- 検証が不成功/失敗した場合:
- FedExが200(OK)または202(Accepted)以外の応答を受信した場合、Webhookリンク先URLの検証は失敗したとみなされます。
Response