概要
Advanced Integrated Visibility Webhookを活用することで、FedExは、1つ以上のFedExアカウント・ナンバーに関連付けられた貨物について、ほぼリアルタイムで安全な追跡イベントデータを指定された仕向地URLにプッシュ送信することができます。FedEx Developer Portalを通じて、この機能を利用するための Webhook プロジェクトの作成することができます。
ナビゲーション・パス
以下のいずれかの方法から、Webhook作成ページにアクセスできます。
- 「マイプロジェクト」から： 左側のナビゲーションパネル → Webhookタブ → +Webhookプロジェクトの作成
- APIカタログから：
- 左側のナビゲーションパネル → APIカタログ
- Advanced Integrated Visibilityで検索またはフィルタリングする
- 概要 → ドキュメントをクリック → Sandboxコンソールで、+プロジェクトの作成をクリックします
- ドキュメント → +Webhookの作成をクリックしてください
Webhookの作成手順
ステップ1：会社形態を選択します
+プロジェクトの作成をクリックし、ドロップダウンメニューから会社の種類を選択します。
- FedExを利用して出荷し、FedEx Webhookをシステムに統合する必要があります
- FedExのデータを用いたソフトウェアソリューションを販売または提供していますが、認定コンパチブル ソリューション プロバイダーではありません。
- 認定されたFedExコンパチブル ソリューション プロバイダーです。
注：現在、FedEx Advanced Integrated Visibility Webhookソリューションは、このオプションではご利用いただけません。FedEx Compatibleプログラムのメンバーとして、Basic Integrated Visibilityやその他のFedEx統合ソリューションへのアクセスをご希望の場合は、担当のチャネルマネージャーにお問い合わせください。担当のチャネルマネージャーがわからない場合は、会社の管理者にお問い合わせください。
次に、サブスクリプションの種類としてAdvanced Integrated Visibility アカウント・ナンバーのサブスクリプションを選択します。
Advanced Integrated Visibilityアカウント・ナンバーのサブスクリプションの作成
作成プロセスには、4つの重要なステップがあります。
ステップ1：Advanced Integrated Visibilityアカウント・ナンバー・サブスクリプションを有効にする
このステップは、第三者のお客様からのリクエストに際し、FedEx管理担当者またはFedEx担当者が対応いたします。
- MNDAドキュメント： FedEx管理担当者またはFedEx担当者が、相互秘密保持契約（MNDA）と、第1当事者／荷送人のアカウント・ナンバーの一括リストを回収いたします。
注：今回のアップロードでは、他の組織に関連付けられている重複するアカウント・ナンバーも許可されます。
- 該当する場合、組織レベルでカスタム料金設定が有効になります。
注：この機能は、7月のエクスペリエンスには含まれていません。
ステップ2：＋プロジェクトを作成する
［製品の選択］ページでは：
- ［Advanced Integrated Visibility – アカウント・ナンバー］をクリックし、続いて［次へ］をクリックしてください。
- ［請求先アカウント］を選択し、支払い条件に同意して、［次へ］をクリックしてください。
少なくとも1つの請求先アカウントを追加する必要があります。
［詳細の確認］ページでは：
- プロジェクト情報を確認します。
- 利用規約に同意します。
- カスタム料金設定が適用される場合、関連する書類が自動的に表示されます。
作成に成功すると、確認メッセージが表示されます。
「製品を［マイプロジェクト］に正常に追加しました。」
ステップ3：プロジェクトの概要 – APIキーの有効化手順
- ［プロジェクトの概要］ページのAPIセクションにある［APIキー］タブでは、サブスクリプションの本番環境ステータスは、最初は「無効」と表示されます。
- FedExの管理担当者または担当者が、リクエストに際して製品を有効化いたします。
- 有効にすると、［実稼働キー］タブが利用可能になり、本番環境のステータスが「確認待ち」に更新されます。
- FedExの管理者または担当者による最終的な有効化が完了すると、実稼働ステータスは「有効」と表示されます。
ステップ4：プロジェクトの概要 – Webhookの設定
- ［プロジェクトの概要］ページに移動します。
- ［Webhook］タブを選択してください。
- ［+ Webhookの設定］ボタンをクリックして、Webhookの設定を開始してください。［Webhook］タブに移動します。
機能の説明
| 項目名 | 説明 |
|---|---|
| 配達証明 | 貨物が正常に配達されたことを証明できます。含まれるもの： 配達証明の写真（PPOD）：正確な配達場所を示す写真を提供できます。 配達証明署名指定（SPOD）：荷受人の署名の画像、名前、配達日、時刻、場所を提供できます。 |
| 配達予定日 | 荷受人が計画を立てられるよう、サポートできます： 配達予定日（EDD） 配達予定時間帯（EDTW） |
| 追跡イベント | 通知を受け取るイベントカテゴリを1つ以上選択できます： 出荷 輸送中 配達 例外 カスタム配達オプション |
| イベントに基づくフィルタリング | Webhookの応答をフィルタリングして、以下を含めるようにします： 輸入貨物 輸出貨物 サードパーティ貨物 |
2.［詳細の入力］ページで、次の情報を入力します。
| 項目名 | 説明 |
|---|---|
| Webhookプロジェクト名 | Webhookプロジェクトの一意の空フィールドではない名前。提案された名前は自動的に入力されますが、編集できます。この名前は、他のWebhookで繰り返し使用することはできません。 |
| リンク先 URL | FedExが追跡イベントデータを送信する安全なHTTPSエンドポイントです。 要件： 有効かつ正常に機能している必要があります 標準化された構文に従う必要があります fedex.comまたはそのサブドメインを含めてはなりません 複数のWebhookで再利用可能です 詳細は、「ビジネスルールとベストプラクティス」セクションを参照してください。 |
| セキュリティトークン | HMAC を使用して Webhook の応答を認証および検証するために使用される共有秘密です。 要件： 26～100文字には、 少なくとも1つの大文字、1つの小文字、1つの数字を含める必要があります。 複数のWebhookで再利用できます |
| ペイロード言語（国） | ドロップダウンリストから、追跡データの翻訳に使用する言語を選択します。 |
| 追跡（種類） | 追跡データの配信方法を選択してください： 詳細な追跡 – 全イベント履歴 イベント固有の追跡 – 最新のイベントのみ |
| Eメールアドレス | 通知を受け取るには、有効なメールアドレスを入力してください。 |
| Eメールの言語（国） | Eメール通知の希望言語を選択してください。 注意：米国のロケールのみをサポートします（例：en-US、es-US）。 |
ステップ3：出荷先アカウントを選択する
［出荷アカウントの選択］ページで：
Webhookプロジェクトに関連付けるには、1つ以上のFedExアカウント・ナンバーを選択します。
重要な注意事項：
他のWebhookにまだ関連付けられていないアカウントのみが表示されます。
続行するには、少なくとも1つのアカウントを関連付ける必要があります。
Webhook UIから最大100件のアカウントを追加できます。
100件を超えるアカウントを関連付けるには、Webhook APIを使用してください。
APIアクセスをリクエストするには、FedExカスタマーサービスまたはヘルプデスクにお問い合わせください。
ステップ4：詳細を確認して作成する
［詳細の確認］ページでは：
1. Webhookプロジェクトに入力したすべての情報を確認します。
2. 利用規約に同意するには、このチェックボックスにチェックマークを入れてください。
3. ［作成］をクリックして、Webhookの設定を確定します。
送信に成功すると、システムが生成したサブスクリプション IDで Webhook が作成され、アクティブステータスに設定されます。
検証ルール：
一般的な要件：
Webhook名は 一意でなければなりません。
リンク先URLは、標準化された構文形式（セキュアなHTTPS、fedex.comまたはそのサブドメインは指定できません）に従う必要があります。
すべての必須フィールドに入力してください。必須フィールドを空欄のままにすることはできません。
少なくとも1つの有効なFedEx出荷アカウント・ナンバーがWebhookに関連付けられている必要があります。
検証の成功：
Webhookが正常に作成されると、お客様は次の確定メッセージを受け取ります。
<<Webhook name>>が正常に作成されました。ただし、変更が有効になるまでに最大10分かかることがあります。
検証の不成功／失敗：
FedExがリンク先 URLからHTTP 200（OK）または202（Accepted）以外の応答を受信した場合、Webhookの検証は失敗したと見なされます。
