はじめに
FedEx APIを利用して、今すぐフェデックスとの統合を開始しましょう。組織を設定してプロジェクトを作成するプロセスと、コンパチブル ユーザーとして開始する方法を次の指示で説明します。
ステップ1:
API を参照してアプリケーションに必要なものを判断します。
- APIカタログにアクセスして、アプリケーションに適したAPIを決定します。
- API を選択してその概要、変更ログ、および主な機能を確認します。
- APIドキュメントを参照しリクエストとレスポンスの要素、ご利用のプログラミング言語での例、エラーコードなどの詳細を確認してください。
- 予定されているサービスの更新情報をアナウンスで確認し、新しい情報を知ることができます。
ステップ2:
登録またはログインしてFedEx APIとの統合を開始します。
- FedEx APIとの統合を開始するにはfedex.comのユーザーIDとパスワードでログインします。
- まだユーザーIDをお持ちでない方は、無料でご登録ください。
ステップ 3:
組織を作る、または組織に参加します。
会社の既存の組織に参加するか、組織が会社にまだ存在しない場合は組織を作成します。組織に複数のユーザーを関連付けることはできますが、1つのユーザーIDに複数の組織を関連付けることはできません。
自分の組織を作成する場合は、自動的にその組織の管理者として表示されます。管理者は、ユーザーを組織に招待し、役割やプロジェクトに割り当て、出荷アカウントを管理することができます。誰にとってどの役割が最適なのかについては、組織管理ガイドラインをご覧ください。自分の組織を作成するには、マイプロジェクトをクリックし、［組織の作成］ボタンをクリックします。このボタンは、既存の組織とユーザーIDがまだ関連付けられていない場合にのみ表示されます。そこから、以下のように入力することで、組織の作成を開始することができます（*が付いているものは任意です）。
- 組織名を入力します。
- 招待したいチームメンバーのEメールアドレスを入力します。これらは自動的に参照者として追加され、プロジェクトが存在しない場合に関連付けられます。*
また、以下の手続きを行うことで会社の組織に参加することができます。
- 会社にすでに作成した組織がある場合は、組織の管理者に自分を招待するように依頼します。相手の招待を受け入れるには24時間の期限がありますが、この期限が過ぎた場合は招待を再送してもらうことができます。
- 招待を受け入れるには既存のユーザーIDとパスワードでログインするか、既存のユーザーIDがすでに組織に関連付けられている場合は新しいユーザーIDを作成する必要があります。
ステップ4:
出荷アカウントを追加します。
管理者は、組織の下で必要なの数の出荷アカウントを追加することができます。開始するには、組織管理 ページの［出荷アカウント］タブから［アカウントの追加］ボタンをクリックします。そこから以下の手順を実行することで、既存の出荷アカウントを組織に追加することができます。
- アカウント情報の入力
アカウント・ナンバー、アカウントのニックネーム、アカウントに関連付けられた請求先住所を入力します。これは詐欺行為を防止するためにアカウントの詳細と一致していることを確認するために検証されます。
ユーザーIDに関連付けられている出荷アカウントは[出荷] ページで確認することができます。尚、フェデックス営業担当者にお問い合わせいただき、新規出荷アカウントを作成してください。
- エンドユーザーライセンス契約
その後、エンドユーザーライセンス契約（EULA）をお客様が承諾されるか、またはエンドユーザー企業内の適切な当事者にこのEULAを送信し承諾してもらいます。EULAの状況は組織管理ページの出荷アカウントタブで確認できます。
ステップ 5:
ユーザーを組織に追加してチームメイトとの共同作業を開始します。
管理者はユーザーを組織に招待し、役割やプロジェクトに割り当てることができます。はじめに、組織管理ページの［ユーザーの追加］タブから［ユーザーの追加］ボタンをクリックします。そこから、以下の手順でユーザーを追加することができます（*がついているものは任意です）。
- 組織への参加が必要なユーザーのEメールアドレスを入力します。キーボードのスペース、カンマ、セミコロン、エンターキーを押して複数のメールアドレスを入力できます。
- 参照者のデフォルトオプションがユーザーのニーズに合わない場合は役割を選択します。*
- ユーザーを割り当てるため組織に関連付けられたプロジェクトを選択します。まだ作成していない場合は次のステップで説明します。*
管理者は常にすべてのプロジェクトにアクセスできますがコントリビューター、または参照者はコントリビューターがプロジェクトを作成した場合を除き、プロジェクトに割り当てられている必要があります。ユーザーがまだ招待を受け入れているかどうかにかかわらず組織管理画面の［ユーザー］タブから直接プロジェクトやロールをすばやく更新することができます。役割やプロジェクトの横にあるキャレットをクリックするだけでドロップダウンから選択可能なオプションが表示されます。必要なオプションを選択し［適用］ボタンを選択して選択を保存します。
ステップ 6:
プロジェクトを作成して認証情報を取得します。
マイプロジェクトページで管理者またはコントリビューターは、［プロジェクトの作成］ボタンを選択してプロジェクトを作成することができます。そこから以下のように入力することで、プロジェクトの作成を開始することができます（*が付いているものは任意です）。
1. プロジェクトの設定
- プロジェクトには、お客様の社内で識別可能で固有な名前を付けます。
- APIを少なくとも1つ選択してプロジェクトに追加します。尚、APIはいつでも追加または削除できます。
2. 利用規約に同意する
- 開発者向けポータルの使用許諾契約を読み、同意し、 ご自身のアプリケーションを配布するつもりがないことを承諾してください。
- 出荷予定の国を選択されますと、テスト出荷アカウントが割り当てられす。欧州の国々で国内出荷パッケージをテストされたい場合は、各国のテストアカウントをお持ちでなければなりません。尚、国はいつでも追加または削除できます。*
- FedEx Ground® Economy ReturnsまたはFedEx Freight® LTLをご利用になる場合は[はい]を選択してください。
- ［作成］ボタンをクリックすると確認画面が表示されます。尚、新規プロジェクト内でテスト認証情報を確認することができます。
ステップ7：
API をアプリケーションに統合し、実働テストします。
- プロジェクト概要ページのテストキータブからテスト資格情報（APIキー、秘密キー、出荷アカウント）を取得します。
- 各APIトランザクションで使用する必要があるOAuthアクセストークンを要求します。トークンのセッションは1時間のみ有効なため、セッションの有効期限が切れる前にアプリケーションがトークンを更新するようにプログラムでコーディングする必要があります。詳細についてはAPI承認のドキュメントを参照してください。
- テストキーページでAPIのドキュメントを選択し、ビジネスコンテキストを読んで選択したAPIの使用方法をよく理解してください。目的の統合に一致するエンドポイントのリクエスト例を確認します。
- リクエストの例で説明したようにこれらのエンドポイントへの呼び出しを実装し、テストの資格情報を使用するように設定します。
- 受信したAPIコールの応答がドキュメントに示されているものと一致していることを確認します。
- テスト認証情報とフェデックステストURIを使用して、フェデックステスト環境内での実働を完全にテストします。
ステップ8：
プロジェクトを実稼働に移行します。
プロジェクト概要ページで、［実稼働キー］タブをクリックします。そこから以下のように入力することで、プロジェクトの実稼働への移動を開始することができます（*が付いているものは任意です）。
- プロジェクトの構成
- 実稼働APIキーの名前を変更します。*
- 現時点では1つの出荷アカウントを追加する必要がありますが、プロジェクトが正常に実稼働に移行した後にさらに追加することができます。組織に関連付けられた出荷アカウントがない場合、または組織に追加された出荷アカウントに対してEULAが署名されていない場合ドロップダウンには表示されません。
- プロジェクトキーを取得します。
- 次に実稼働APIキーと実稼働秘密キーが表示されます。安全な場所にコピーします。
- 実稼働秘密キーを安全に保つために、一度だけ表示します。紛失した場合は新たに生成することができます。
ステップ9：
統合を完了します。
- APIの中には当社の実稼働環境で使用するため、基本的なラベル認証と出荷ラベル認証のいずれかを必要とするものがあります。この要件のあるプロジェクトで任意の API の認証プロセスを完了します。
- すべての API が認証されて有効になったらテストURI、キー、および出荷アカウントを実稼働用のURI、キー、および出荷アカウントに置き換えてAPIリクエストを更新します。
- サンプルデータを使用して実稼働環境での実装を再テストします。
- 新しい統合のメリットをご体験ください。
開発者ではない方、またはFedEx APIとの統合の準備ができているかどうかわからない方はこちらをご覧ください。統合がビジネスにどのような効果をもたらすかについて詳しくはこちらをご覧ください。
ステップ１：
フェデックスが互換プロバイダー組織を作成します。
- フェデックスが組織を作成し、チームメンバーを1名組織に招待します。このユーザーは、組織の「管理者」として指定されます。
- 認証と統合の完了後、顧客にサービスを簡単に配布できるようになります。
ステップ2:
招待を承諾してください。
- API統合アーティファクトとドキュメントにアクセスするには、招待を承諾しなければなりません。招待を承諾するには、フェデックスのユーザーIDとパスワードを使用してログインするか、認証情報をまだお持ちでない場合は新しいパスワードを作成してください。
ステップ 3:
ユーザーをお客様の組織に招待します。
- 管理者は、プロジェクトまたは組織へのアクセス権を必要とするチームメンバーを招待することができます。さまざまな役割の詳細につきましては、「組織管理ガイド」をご覧ください。
- すでに組織を作成された場合は、組織の管理者にお客様を招待するようご依頼ください。招待は24時間有効です。もし、この期限以内にアクションを起こされなかった場合は、招待を再送してもらってください。
ステップ4:
希望されるAPIを選択してください。
APIカタログにアクセスして、ソリューションに適したAPIを決定してください。フェデックス カスタマー テクノロジー コンサルタント（CTC）と互換チャネル マネージャーは、お客様のビジネスニーズに応じてソリューションに適したAPIの選択をサポートいたします。
API を選択してその概要、変更ログ、および主要機能を確認してください。
API文書を参照し、リクエストとレスポンスの要素、ご利用の言語、エラーオブジェクトなどの例をご確認ください。
Salesforceに戻り、製品情報ワークシート（PIW）に記入し、ソリューションに追加するAPIをリストしてください。
ステップ 5:
フェデックスがプロジェクトを作成いたします。
PIWが承認されますと、フェデックスがプロジェクトを作成します。各ソリューションの各バージョンは、FedEx Developer Portal内に個別のプロジェクトを持つことになります。ユーザーが組織の管理者でない場合は、各プロジェクトを閲覧できるように招待しなければなりません。
フェデックス互換チーム、フェデックスCTC、認証チームがお客様にAPI技術をデモンストレーションいたします。フェデックスチームが、お客様が採用されているAPIのバージョンで利用可能な新機能についてご説明いたします。チームが、API、APIテスト、APIの「認証*」のプロセスを開始するために完了すべき全プロセスに関する技術的な質問にお答えします。
*認証 – プログラムコンプライアンス要件を満たすためにフェデックス互換プログラムによって定義されたプロセス。フェデックステクノロジーおよびサービス基準に定義する通り、互換プログラム認証は、互換性のある全プロバイダーがフェデックステクノロジーを実装、販売、および荷送人（顧客）に配布することを保証するために欠かせません。
ステップ 6:
APIをお客様のアプリケーションに統合し、互換性のあるプログラムとして認証してください。
- これで、テストAPIキーとテスト秘密キーにアクセスして、トランザクションの実行を開始できます。[プロジェクトの概要]ページの[テストキー]タブからそれらを取得してください。
![「[プロジェクト概要テストキー]タブ」ページのスクリーンショット](/api/content/dam/fedex-com/irc/getting-started/step-6a-integrate@2x.png)
- 顧客キーを作成するには、各プロジェクトのAPIセクションにのみあるプライベートAPIの「認証情報登録API」を使用しなければなりません。
- 複数のカスタマーキーを作成後、先に進み、すべてのAPIトランザクションで使用するOAuthアクセストークンをリクエストしてください。トークンのセッションは1時間だけ有効なため、セッションの有効期限が切れる前にアプリケーションがトークンを更新するようにプログラムでコーディングしなければなりません。詳細につきましてはAPI承認のドキュメントをご覧ください。サンプルコードを表示する際は、サンプルドロップダウンから「再販業者」が選択されていることを確認してください。
- テストキーページでAPIのドキュメントを選択し、ビジネスコンテキストを読んで選択したAPIの使用方法をよく理解してください。目的の統合に一致するエンドポイントのリクエスト例を確認します。
- リクエストの例で説明したようにこれらのエンドポイントへの呼び出しを実装し、テストの資格情報を使用するように設定します。
- 受信したAPIコールの応答がドキュメントに示されているものと一致していることを確認します。
- テスト認証情報とフェデックステストURIを使用して、フェデックステスト環境内での実働を完全にテストします。
- ソリューションを完全にテストされた後、Salesforceで各ソリューションを認証してください。フェデックスは提出されたすべてを完全に確認し、承認後、認証を更新します。
ステップ7：
フェデックスがプロジェクトを実稼働に移行します。
- その後、フェデックスはプロジェクトを実稼働に移行します。
- これで、[プロジェクトの概要]ページの[実稼働キー]タブに実稼働APIキーが表示されます。
![「[プロジェクト概要運用]タブページに表示された生成リンク付きの互換バージョン」のスクリーンショット](/api/content/dam/fedex-com/irc/getting-started/step-7-project-to-production@2x.png)
ステップ8：
実稼働秘密キーを生成します。
- 実稼働秘密キーは、[秘密キー]列の下にある[秘密の生成]リンクをクリックして生成しなければなりません。
- これで、サンプルデータを使用して実稼働環境での実装を再テストすることができます。
- 新しい統合のメリットをご体験ください。
