Advanced Integrated Visibilityの機能
Advanced Integrated Visibility Webhookを使用すると、FedExは特定のURL宛てに、安全かつほぼリアルタイムの追跡情報を送信することができます。これらの更新情報は、1つ以上のFedExアカウント・ナンバーに関連付けられた貨物を対象としています。この機能をご利用いただくには、「Advanced Integrated Visibility Webhookプロジェクト」を作成する必要があります。
「Advanced Integrated Visibility」ページへのアクセス方法
「Advanced Integrated Visibility」の設定画面には、次の2つの方法でアクセスできます。
オプション1：「マイプロジェクト」経由
1. 左側のナビゲーションパネルの［マイプロジェクト］に移動してください。
2. ［Webhook］タブをクリックします。
3. +Webhookプロジェクトの作成を選択します。
オプション2: APIカタログを通じて
1. 左側のナビゲーションパネルからAPIカタログを開きます。
2. Advanced Integrated Visibilityを検索します。
3. WEBHOOK フィルターを使って正しいカードを探します。
4. カードに：
- ［概要］をクリックし、［ドキュメント］ボタンをクリックして、［+WEBHOOKプロジェクトの作成］を選択します。
- または、［ドキュメント］に移動し、［+WEBHOOKプロジェクトの作成］をクリックします。
ステップ1：会社形態を選択します
+プロジェクトの作成をクリックし、ドロップダウンメニューから会社の種類を選択します。
1. FedExを利用して出荷し、FedEx Webhookをシステムに統合する必要があります
2. FedExのデータを用いたソフトウェアソリューションを販売または提供していますが、FedEx Compatible Providerではありません。
3. 認定されたFedEx Compatible Providerです。
次に、サブスクリプションの種類としてAdvanced Integrated Visibility追跡番号のサブスクリプションを選択します。
Advanced Integrated Visibility追跡番号に基づくサブスクリプションの作成
「Advanced Integrated Visibility追跡番号サブスクリプション」を設定することで、1つまたは複数のFedEx追跡番号について、安全かつほぼリアルタイムの追跡情報を取得することができます。これらの更新情報は、指定されたリンク先URLに送信されます。
サブスクリプションを作成する手順
このプロセスには主に4つのステップがあります。
1. プロジェクトの構成
2. プロジェクトの詳細の入力
3. 詳細を確認し、規約に同意
4. 追跡番号を追加
ステップバイステップの説明
1. Webhookの設定ページで：
請求先アカウント番号を確認します
お客様の組織のデフォルトの請求先アカウント・ナンバーが表示されます。
変更するには：
- ［貴社に請求先アカウントを追加］をクリックしてください（アカウントが1つしかない場合）、または
- （複数のアカウントをお持ちの場合は）［別の請求先アカウントを選択］をクリックしてください。
注：料金の詳細については、「Advanced Integrated Visibility」の概要ページをご覧ください。
2. 機能の選択
- 必要な機能を選んでください。
- ［次へ］をクリックして続行します。
ヒント：各機能の詳細は、その横にあるヘルプアイコン（？）をクリックしてご確認ください。
機能の説明
| 項目名 | 説明 |
|---|---|
| 配達証明 | 貨物が正常に配達されたことを証明できます。含まれるもの：
|
| 配達予定日 | 荷受人が計画を立てられるよう、サポートできます：
|
| 追跡イベント | 通知を受け取るイベントカテゴリを1つ以上選択できます：
|
［詳細の入力］ページで、次の情報を入力します。
| 項目名 | 説明 |
|---|---|
| Webhookプロジェクト名 | Webhookプロジェクトの一意の空フィールドではない名前。提案された名前は自動的に入力されますが、編集できます。この名前は、他のWebhookで繰り返し使用することはできません。 |
| リンク先 URL | FedExが追跡イベントデータを送信する安全なHTTPSエンドポイントです。 必要条件：
|
| セキュリティトークン | HMAC を使用して Webhook の応答を認証および検証するために使用される共有秘密です。 必要条件：
|
| ペイロード言語（国） | ドロップダウンリストから、追跡データの翻訳に使用する言語を選択します。 |
| 追跡（種類） | 追跡データの配信方法を選択してください。
|
| Eメールアドレス | 通知を受け取るには、有効なメールアドレスを入力してください。 |
| Eメールの言語（国） | Eメール通知の希望言語を選択してください。 注意：米国のロケールのみをサポートします（例：en-US、es-US）。 |
［詳細の確認］ページでは：
- Webhookプロジェクトの詳細を確認してください。
- 利用規約を確認し、同意してください。
- ［作成］をクリックして、Webhookプロジェクトの設定を完了してください。
4. リクエストが正常に送信されると：
- FedExは、新しいWebhookプロジェクトを立ち上げます。
- Advanced Integrated Visibility Tracking Number Subscription APIの実稼働キーをお受け取りいただけます。
- このAPIを使用すると、プロジェクトに追跡番号を紐付けることができます。
詳細については、Advanced Integrated Visibility Tracking Number Subscription APIのドキュメントページを参照してください。
Webhookに追跡番号をを追加する方法
「Advanced Integrated Visibility Tracking Number Subscription API」を使用して、Webhookサブスクリプションに追跡番号を追加するには、以下の手順に従ってください。
手順
1. サブスクリプション・プロジェクトを作成する
・前のセクションの手順に従うか、入門ガイドを参照してください。
2. OAuthトークンを生成する
- APIを呼び出すには、OAuthトークンが必要です。
- Authorization APIを使用してトークンを生成します。
- 詳細な手順については、APIカタログのAuthorization APIのドキュメントをご参照ください。
3. 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の検証は失敗したとみなされます。 |
