開始する
FedExと統合すると、FedEx APIとWebhookが提供する値を活用できるようになります。これらの手順は、組織のセットアップ、プロジェクトの作成、または互換性のあるユーザーとしての開始のプロセスをガイドします。
ステップ1:
APIとWebhookを参照
まずはAPIとWebhookを参照してニーズを判断し、アプリケーションに最適なソリューションを特定します。
- APIカタログに移動して参照を開始します。
- APIまたはWebhookを選択して、概要を読み、変更ログを調べ、主要な機能を確認します。
- ドキュメントを参照しリクエストとレスポンスの要素、ご利用のプログラミング言語での例、エラーコードなどの詳細を確認してください。
- 予定されているサービスの更新情報をお知らせページで確認し、新しい情報を知ることができます。
ステップ2:
登録またはログイン
FedEx APIとWebhookとの統合を開始するにはfedex.comのユーザーIDとパスワードでログインします。
まだユーザーIDをお持ちでない方は、ご登録ください（無料）。
ステップ 3:
組織を作る、または組織に参加します。
会社の既存の組織に参加するか、組織が会社にまだ存在しない場合は組織を作成します。
組織を作成するには：
組織を作成する場合は、お客様は自動的にその組織の管理者として表示されます。
- 管理者は、ユーザーを組織に招待し、役割（例：コントリビューターまたは閲覧者）とプロジェクトを管理し、出荷アカウントを管理できます。
- これらの役割の詳細については、組織管理ガイドラインを参照してください。
独自の組織を作成するには、左側のナビゲーションで[組織の作成]をクリックします。
組織情報の提供
- 会社名、WebサイトのURLを入力し、組織名を作成します。他のユーザーが認識できる名前を組織につけます。この名前は、お客様の会社をさらに細かいグループに組織分けするのに使用することができたり（例：部、課、地域、所在地）または会社名と同じにすることもできます。
組織に参加するには：
次の手順を完了することで、既存の組織に参加できます。
- 組織の管理者に招待状の送信を依頼
- 会社にすでに組織がある場合は、組織の管理者にあなたを招待するように依頼しましょう。招待の有効期間は送信から24時間以内となります。この期限が過ぎても招待を再送してもらうことができます。
- 招待を承諾
- 招待を受け入れるには、既存のユーザーIDとパスワードを使用してログインするか、既存のユーザーIDがすでに組織に関連付けられている場合は、新しいユーザーIDを作成する必要があります。
ステップ4:
出荷アカウントを追加します。
- アカウント情報の入力
- アカウント・ナンバー、アカウントのニックネーム、アカウントに関連付けられた請求先住所を入力します。その後、不正行為を防止するために、請求先住所がアカウントの詳細と一致することを確認します。
- ユーザーIDに関連付けられた出荷アカウントを表示するには、「組織の管理」ページと「出荷アカウント」タブに移動します。新しい出荷アカウントを作成するには、FedEx営業担当者にお問い合わせください。
- エンドユーザーライセンス契約
- その後、エンドユーザーライセンス契約（EULA）に同意するか、エンドユーザー企業内の契約に同意できる別の個人にEULAを送信する必要があります。EULAのステータスは、[組織の管理]ページの[出荷アカウント]タブで確認できます。
ステップ 5:
組織にユーザーを追加
管理者はユーザーを組織に招待し、役割やプロジェクトに割り当てることができます。まず、次の手順を実行して、「組織の管理」ページからユーザーを追加できます（*の付いた手順はオプションです）。
ユーザーのメールアドレスを入力してください
- 組織に招待するユーザーのEメールアドレスを入力します。アドレス間にスペース、カンマ、セミコロン、またはキーボードのEnterキーを押すと、複数のEメールアドレスを入力できます。
ユーザーの役割を選択
- ビューワーのデフォルトオプションがユーザーのニーズと一致しない場合は、別のユーザーの役割を選択します。*
ユーザーをプロジェクトに割り当てる
- すでにプロジェクトを作成している場合は、ユーザーをプロジェクトに割り当てることができます。*
管理者は常にすべてのプロジェクトにアクセスできますが、共同作成者またはビューワーはプロジェクトに割り当てる必要があります（ただし、共同作成者がプロジェクトを作成する場合は自動的にそのプロジェクトに割り当てられます）。
ユーザーが招待を承諾したかどうかに関係なく、「ユーザー」タブの「組織の管理」ページから直接プロジェクトやロールをすぐに更新できます。
- 役職またはプロジェクトの横にあるキャレットをクリックすると、オプションを含むドロップダウンが表示されます
- オプションを選択し、[適用]ボタンを選択して、選択内容を保存します。
ステップ１：
プロジェクトを作成して認証情報を取得します。
組織の管理者または共同作成者は、[APIプロジェクトを作成]ボタンをクリックしてAPIプロジェクトを作成開始することができます。
開始する前に、まず、FedEx APIにアクセスする必要がある理由をお知らせください。モーダルが表示され、ドロップダウンオプションが表示されます。FedEx APIを統合したいビジネスニーズを最もよく表すオプションを選択する必要があります。
荷送人として指定している場合は、プロジェクトを作成開始できます。手順は3つあります。
- APIの選択
プロジェクトに含めるAPIを選択します。選択したAPIに基づいて、追加の選択が必要になることがあります。
Track APIを選択した場合は、次のことも実行する必要があります。
- 実稼働キーに関連付けるアカウント・ナンバーを選択します。
- Track APIクォータ、レート制限、およびAPI認証の詳細を確認します。
- トランザクションクォータを超過した場合に通知するEメールをオプトインするかどうかを選択します。
- プロジェクトの構成
名前や出荷場所など、プロジェクトの詳細を入力します。
- プロジェクトには、お客様の社内で識別可能で固有な名前を付けます。
- 出荷予定の国を選択すると、テスト出荷アカウントが割り当てられす。ヨーロッパ国内で貨物をテスト出荷するには国ごとに別のテストアカウントを用意する必要があります。なお、国はいつでも追加または削除できます。
- 通知条件を設定することで。APIに関する最新情報および停止関連情報に関する通知を受け取ることができます。
- 詳細を確認
プロジェクトの詳細を確認し、契約条件に同意します。
- FedEx Developer Portalのライセンス契約を読み、同意し、アプリケーションを販売まはた配布するつもりがないことを承諾してください。
- 「作成」ボタンをクリックすると、確認画面が表示されます。その後、新しいプロジェクト内でテスト認証情報を表示できます。
ステップ2:
APIを統合し、実装をテスト
「テストキー」タブでテスト認証情報（APIキー、秘密キー、および出荷アカウント）を取得します。その後：
- 各APIトランザクションで使用する必要があるOAuthアクセストークンを要求します。トークンのセッションは1時間だけ有効なため、セッションの有効期限が切れる前にアプリケーションがトークンを更新するようにプログラムでコーディングしなければなりません。詳細につきましてはAPI承認のドキュメントをご覧ください。
- APIのいずれかのドキュメントをクリックすると、各APIのビジネスコンテキストを読むことができ、APIの使用方法をよりよく理解することができます。希望する統合に一致するエンドポイントのリクエスト例を確認することもできます。
- リクエストの例で説明したようにこれらのエンドポイントへの呼び出しを実装し、テストの認証情報を使用するように設定します。
- 受け取ったAPI呼び出しのレスポンスがドキュメントに示されているものと一致していることを確認してください。
- テスト認証情報とFedExテストURLを使用して、FedExテスト環境内で実装をテストします。
ステップ 3:
プロジェクトを実稼働に移行
次の手順で、プロジェクトを実稼働環境に移行できるようになります。
プロジェクトの構成手順内：
- 必要に応じてキーの名前を変更できます。
- プロジェクト作成フローの手順1で選択したアカウント・ナンバーを確認します。これは、プロジェクトを実稼働環境に移行するために使用されます。プロジェクトが運用環境で稼働すると、必要に応じてアカウントを追加できます。
プロジェクトキーの取得手順内：
- 実稼働APIキーと実稼働秘密キーが表示されます。安全な場所にコピーします。
- 実稼働秘密キーを安全に保つために、一度だけ表示します。紛失した場合は新たに生成することができます。
- ［次へ］をクリックします。
プロジェクト概要ページに戻ります。ここで、プロジェクトに関連付けられたアカウントをさらに追加できます。
プロジェクト概要ページ：
- 3つの垂直点（またはケバブメニュー）をクリックして、プロジェクトに関連付けられたアカウントをさらに追加できます。
- 次に、[編集]をクリックします。
これにより、APIキーページが表示され、このプロジェクトの実稼働キーに関連付けるアカウントを追加できます。
ステップ4:
認証を完了してください
- APIの中には当社の実稼働環境で使用するため、出荷ラベル認証のいずれかを必要とするものがあります。この要件のあるプロジェクトで任意のAPIの認証プロセスを完了します。
すべての API が認証されて有効になるとテストURI、キー、および出荷アカウントを実稼働用のURI、キー、および出荷アカウントに置き換えてAPIリクエストを更新します。
サンプルデータを使用して実稼働環境での実装を再テストします。
新しい統合のメリットをご体験ください。
Webhookプロジェクトを作成するための前提条件
Webhookプロジェクトを作成
Webhookプロジェクトを作成するための前提条件
ステップ1:
仕向地アプリケーション／プラットフォームで有効なURLを作成します
FedExから認証コード／メッセージとTracking Webhookペイロード通知を受け取るために、仕向地アプリケーション／プラットフォームで有効なURLを作成してください。
URL要件：
- RFC1918 IPスペースを含む
- fedex.comまたはそのサブドメインのいずれかを含む
- URLにIPアドレスを含む（localhost、127.0.0.1を含む）
ステップ2:
セキュリティトークンを生成
このセキュリティトークンは、お客様（顧客）とFedExの間で送信される情報を認証および検証するための秘密キーとして使用できます。
セキュリティトークンの要件：
- 最小長は25文字、最大長は100文字です
- 大文字1文字
- 小文字1文字
- 数字1個
ステップ 3:
Webhook URLをテスト
URLのテストはオプションのステップであり、役立つ場合があります。
テストは、手順1で作成したURLが有効かどうかをよりよく理解するのに役立ちます。これにより、FedExがURLを識別し、URLとの接続を構築してデータを送信できるようになります。テストでは、アプリケーションで提供される追跡データを処理できるかどうかを確認および検証するのに役立つサンプルテストデータも提供されます。ただし、テストではURLは認証されません。
WebhookURLをテストする方法については、Webhookのドキュメントをご確認ください。
ステップ4:
仕向地URLを検証
HMAC SHA256ハッシュアルゴリズム方式を使用して、仕向地URLとFedExの間で送信される情報を検証する認証プロセスを設定します。
- [作成]をクリックすると、FedExによってランダムなチャレンジ文字列が生成され、リクエスト本文で送信されます。次に、このチャレンジ文字列をレスポンス本文でFedExに返すことが期待されます。
- HMAC SHA256アルゴリズム／手順を使用してメッセージ認証コード（MAC）を初期化し、チャレンジ文字列とセキュリティトークン（または秘密キー）をハッシュ（または結合）してハッシュ署名を形成します。
- HTTPステータスコード200（OK）または202（ACCEPTED）とともに、レスポンス本文にChallengeStringとChallengeStringResponseを含めてFedExにレスポンスします。
- FedExは、チャレンジ文字列とチャレンジ文字列の応答を検証します。
- FedExが応答本文を受信すと、FedExは、ChallengeStringおよびChallengeStringResponse（または以前に生成されたハッシュ署名）を、FedExが生成したChallengeStringおよびハッシュ署名とそれぞれ比較することによって検証します。
- 「challengeString」とHMAC署名の両方が一致する場合、検証とワークフローは成功しています。それ以外は、検証プロセスが失敗し、それぞれのエラーメッセージが表示されます。
Webhookプロジェクトを作成
ステップ1:
構成されたペイロード通知を受信するためのWebhookプロジェクトを作成
[マイプロジェクト]ページで、[Webhook]タブに移動します。
組織の管理者または共同作成者は、[Webhookプロジェクトを作成]ボタンをクリックしてWebhookプロジェクトを作成できます。
開始する前に、まず、FedEx Webhookにアクセスする必要がある理由をお知らせください。モーダルが表示され、ドロップダウンオプションが表示されます。FedEx Webhookを統合したいビジネスニーズを最もよく表すオプションを選択する必要があります。
荷送人として指定している場合は、次の手順でプロジェクトの作成を開始することができます。
- ビジネスニーズを特定
- お客様のビジネスがFedEx Webhookと統合したい理由を最も適切に特定するオプションを選択してください。
- レベルとレベルの機能を選択
- プロジェクトのニーズに基づいて、プロジェクトの基本Webhookレベルまたは高度なWebhookレベルを選択します。
- レベルの選択は後ほどいつでも編集できます。
- 各レベルには月額サブスクリプション料金が課されます。
- プロジェクトで構成したい機能を選択します。
- 後ほど機能を編集することもできます。
- プロジェクトの詳細を構成
- プロジェクトに識別可能な名前を付けう
- 事前に生成された仕向地URLとセキュリティトークンの詳細を提供。これらは、事前セットアップ認証中に作成されます。
| 項目名 | 説明 |
|---|---|
Webhookプロジェクト名 仕向地URL |
これは空欄でなく一意のWebhookプロジェクト名であり、他のWebhookプロジェクトで繰り返すことはできません。
これは、追跡イベントデータ／ペイロードを受け取る先のURLです。
|
セキュリティトークン |
これは、Tracking Webhookレスポンスを認証および検証するための共有秘密として使用されます。
|
ペイロード言語 追跡タイプ |
ドロップダウンリストから、追跡データの移行に使用する言語を選択します。 追跡データを受信する必要があるレスポンスのタイプを選択
|
Eメールアドレス |
Webhookプロジェクトに変更が加えられた場合（作成、編集、キャンセルなど）、Eメール通知を受け取るEメールアドレスを入力します。 |
Eメールの言語（国） |
FedExからWebhook Eメール通知を受信する際に使用する優先言語を選択 Eメール通知でサポートされている言語は次のとおりです。
|
- アカウントの選択
- プロジェクトに関連付ける対象となる（米国またはカナダベースの）アカウント・ナンバーのリストから選択します。
5. 詳細を確認し、規約に同意
- 構成されたプロジェクトの詳細を確認します。
- Developer Portalのライセンス契約を読み、同意し、アプリケーションを配布するつもりがないことを承諾してください。
- 価格契約を読み同意します。
- 「プロジェクトの作成」ボタンをクリックすると：
- 作成リクエストが正常に検証および処理されると、確認画面が表示されます。
- 検証が成功しなかった場合、または失敗した場合は、エラーメッセージが表示されます。
- Tracking Webhookプロジェクトにはシステムが生成したWebhook IDが付けられ、「アクティブ」ステータスとして表示されます。
ステップ１：
FedExがCompatibleプロバイダー組織を作成します。
- FedExが組織を作成し、チームメンバーを1名組織に招待します。このユーザーは、組織の管理者として指定されます。
- 認証と統合の完了後、顧客にサービスを簡単に配布できるようになります。
ステップ2:
招待を承諾してください。
- API統合アーティファクトとドキュメントにアクセスするには、招待を承諾しなければなりません。招待を承諾するには、フェデックスのユーザーIDとパスワードを使用してログインするか、認証情報をまだお持ちでない場合は新しいパスワードを作成してください。
ステップ 3:
ユーザーをお客様の組織に招待します。
- 管理者は、プロジェクトまたは組織へのアクセス権を必要とするチームメンバーを招待することができます。さまざまな役割の詳細につきましては、「組織管理ガイド」をご覧ください。
- すでに組織を作成された場合は、組織の管理者にお客様を招待するようご依頼ください。招待は24時間有効です。もし、この期限以内にアクションを起こされなかった場合は、招待を再送してもらってください。
ステップ4:
希望されるAPIを選択してください。
APIカタログにアクセスして、ソリューションに適したAPIを決定してください。FedEx カスタマーテクノロジーコンサルタント（CTC）とコンパチブルチャネルマネージャーは、お客様のビジネスニーズに応じてソリューションに適したAPIの選択をサポートいたします。
API を選択してその概要、変更ログ、および主要機能を確認してください。
API文書を参照し、リクエストとレスポンスの要素、ご利用の言語、エラーオブジェクトなどの例をご確認ください。
Salesforceに戻り、製品情報ワークシート（PIW）に記入し、ソリューションに追加するAPIをリストしてください。
ステップ 5:
フェデックスがプロジェクトを作成いたします。
PIWが承認されますと、フェデックスがプロジェクトを作成します。各ソリューションの各バージョンは、FedEx Developer Portal内に個別のプロジェクトを持つことになります。ユーザーが組織の管理者でない場合は、各プロジェクトを閲覧できるように招待しなければなりません。
フェデックス互換チーム、フェデックスCTC、認証チームがお客様にAPI技術をデモンストレーションいたします。フェデックスチームが、お客様が採用されているAPIのバージョンで利用可能な新機能についてご説明いたします。チームが、API、APIテスト、APIの「認証*」のプロセスを開始するために完了すべき全プロセスに関する技術的な質問にお答えします。
*認証 – プログラムコンプライアンス要件を満たすためにフェデックス互換プログラムによって定義されたプロセス。フェデックステクノロジーおよびサービス基準に定義する通り、互換プログラム認証は、互換性のある全プロバイダーがフェデックステクノロジーを実装、販売、および荷送人（顧客）に配布することを保証するために欠かせません。
ステップ 6:
APIをお客様のアプリケーションに統合し、互換性のあるプログラムとして認証してください。
- これで、テストAPIキーとテスト秘密キーにアクセスして、トランザクションの実行を開始できます。[プロジェクトの概要]ページの[テストキー]タブからそれらを取得してください。
- 顧客キーを作成するには、各プロジェクトのAPIセクションにのみあるプライベートAPIの「認証情報登録API」を使用しなければなりません。
- 複数のカスタマーキーを作成後、先に進み、すべてのAPIトランザクションで使用するOAuthアクセストークンをリクエストしてください。トークンのセッションは1時間だけ有効なため、セッションの有効期限が切れる前にアプリケーションがトークンを更新するようにプログラムでコーディングしなければなりません。詳細につきましてはAPI承認のドキュメントをご覧ください。サンプルコードを表示する際は、サンプルドロップダウンから「再販業者」が選択されていることを確認してください。
- テストキーページでAPIのドキュメントを選択し、ビジネスコンテキストを読んで選択したAPIの使用方法をよく理解してください。目的の統合に一致するエンドポイントのリクエスト例を確認します。
- リクエストの例で説明したようにこれらのエンドポイントへの呼び出しを実装し、テストの資格情報を使用するように設定します。
- 受信したAPIコールの応答がドキュメントに示されているものと一致していることを確認します。
- テスト認証情報とフェデックステストURIを使用して、フェデックステスト環境内での実働を完全にテストします。
- ソリューションを完全にテストされた後、Salesforceで各ソリューションを認証してください。フェデックスは提出されたすべてを完全に確認し、承認後、認証を更新します。
ステップ7：
フェデックスがプロジェクトを実稼働に移行します。
- その後、フェデックスはプロジェクトを実稼働に移行します。
- これで、[プロジェクトの概要]ページの[実稼働キー]タブに実稼働APIキーが表示されます。
ステップ8：
実稼働秘密キーを生成します。
- 実稼働秘密キーは、[秘密キー]列の下にある[秘密キーを生成]リンクをクリックして生成しなければなりません。
- これで、サンプルデータを使用して実稼働環境での実装を再テストすることができます。
- 新しい統合のメリットをご体験ください。
