Advanced Integrated Visibilityの機能
Advanced Integrated Visibility Webhookの概要
Advanced Integrated Visibility Webhookを利用することで、FedExは、指定されたFedExアカウント・ナンバーに紐付けられた貨物について、ほぼリアルタイムの追跡イベントデータを指定された仕向地URLへ安全に送信することができます。
この機能をご利用いただくには、FedEx管理者またはDI管理者がAdvanced Integrated Visibility Webhookプロジェクトを作成する必要があります。
ナビゲーションオプション
Advanced Integrated Visibility Webhooksページにアクセスする方法は2つあります。
オプション1:[マイプロジェクト]経由
- 左側のナビゲーションパネルから[マイプロジェクト]に移動します。
- [Webhook]タブをクリックします。
オプション2:APIカタログ経由
- 左側のナビゲーションパネルから[APIカタログ] にアクセスします。
- 検索バーを使用してAdvanced Integrated Visibilityを検索するか、フィルターセクションから選択します。
- Webhookカードで、次のいずれかを選択します。
- ドキュメント→をクリックしてから[+Webhookの管理]を選んでください
Advanced Integrated Visibility追跡番号に基づくサブスクリプションの表示
1. FedEx個人アクセスと設定
- FedExの管理者またはFedEx担当者がセットアップ手続きを開始します。
- 組織プロフィールは、指定された管理者によってCSPのお客様に代わって作成されます。
- 管理者がお客様に代わって、組織レベルで米国に所在する有効な請求先アカウント・ナンバーを追加します。
- この設定を行う管理者は、組織レベルの設定を管理するための適切な権限を持っている必要があります。
2. 追跡番号の登録に関するワークフローを表示する
2.1 サブスクリプションを表示する
- FedExの管理担当者または担当者がプロジェクトを作成すると、ユーザーはダッシュボード内で、そのプロジェクトに関連付けられた「Advanced Integrated Visibility – 追跡番号サブスクリプション・プロジェクト」を確認できるようになります。
2. 機能を見る
- ユーザーは、サブスクリプション・プロジェクトに関連する利用可能な機能を詳しく確認し、より深く理解して活用することができます。
機能の説明
| 項目名 | 説明 |
|---|---|
| 配達証明 | 貨物が正常に配達されたことを証明できます。含まれるもの:
|
| 配達予定日 | 荷受人が計画を立てられるよう、サポートできます:
|
| 追跡イベント | 通知を受け取るイベントカテゴリを1つ以上選択できます:
|
「詳細」ページには、以下の情報が表示されます。
| 項目名 | 説明 |
|---|---|
| Webhookプロジェクト名 | Webhookプロジェクトの一意の空フィールドではない名前。提案された名前は自動的に入力されますが、編集できます。この名前は、他のWebhookで繰り返し使用することはできません。 |
| リンク先 URL | FedExが追跡イベントデータを送信する安全なHTTPSエンドポイントです。 必要条件:
|
| セキュリティトークン | HMAC を使用して Webhook の応答を認証および検証するために使用される共有秘密です。 必要条件:
|
| ペイロード言語(国) | ドロップダウンリストから、追跡データの翻訳に使用する言語を選択します。 |
| 追跡(種類) | 追跡データの配信方法を選択してください。
|
| Eメールアドレス | 通知を受け取るには、有効なメールアドレスを入力してください。 |
| Eメールの言語(国) | Eメール通知の希望言語を選択してください。 注意:米国のロケールのみをサポートします(例:en-US、es-US)。 |
手順
4. サブスクリプション・プロジェクトを作成する
- 前のセクションの手順に従うか、入門ガイドを参照してください。
5. OAuthトークンを生成する
- APIを呼び出すには、OAuthトークンが必要です。
- Authorization APIを使用してトークンを生成します。
- 詳細な手順については、APIカタログのAuthorization APIのドキュメントをご参照ください。
6. APIドキュメントにアクセスする
- 左側のナビゲーションメニューで、「プロジェクトの詳細」をクリックします。
- [実稼働キー]タブで、[Advanced Integrated Visibility Tracking Number Subscription API]ドキュメントまでスクロールダウンします。
APIエンドポイントの概要
| エンドポイント | 目的 |
|---|---|
| 追跡番号の関連付け | Webhookサブスクリプションから追跡番号を追加または削除します。非同期処理されます。応答にジョブIDが返されます。 |
| 追跡番号ジョブの詳細 | 正常に追加された追跡番号の数や、まだ処理中の追跡番号の数など、特定のジョブIDの詳細情報を提供します。 |
| 追跡番号のジョブ状況 | 現在処理中のすべてのジョブの概要を返します。 |
ステップ2で取得したOAuthトークンを「追跡番号の関連付け」エンドポイントで使用し、Webhookに追跡番号を追加してください。
検証ルール:
- Webhook名は一意でなければなりません。
- リンク先URLは、標準的な構文形式に従う必要があります。
- 必須項目はすべて入力します。
- 少なくとも1つの有効なFedExアカウント・ナンバーを登録する必要があります。
検証結果
| 処理状況 | 詳細 |
|---|---|
| 成功 | 次の確認メッセージが表示されます: 「<> が正常に作成されました。ただし、変更が有効になるまでに最大10分かかることがあります。」 |
| 失敗 | FedExが200(OK)または202(受理)以外の応答を受け取った場合、Webhookのリンク先URLの検証は失敗したとみなされます。 |
Response