開始する
FedEx Developer Portalは、FedExをアプリケーションに統合するための一連のアプリケーション・プログラミング・インターフェース(API)を提供しています・この説明は、組織の設定、プロジェクトの作成、統合のテスト、プロジェクトを本番環境に移行するステップ、および場合によってはAPIの検証を行うステップについてご説明します。
ユーザーの種類:
FedExは、3種類のユーザー向けに統合サービスを提供しています。FedEx荷送人、FedEx Compatible Providerとして知られる検証済みソフトウェアソリューション、およびFedEx認定インテグレータープロバイダーです。
FedEx荷送人:
FedExを利用して出荷を行い、FedEx APIを自社のアプリケーションに統合する必要がある企業。
ソリューションまたはサービスプロバイダー:
FedEx APIを統合して、FedExを利用して出荷を行う外部組織に販売および/または配布できるソリューション、アプリケーション、またはプラグインを構築する必要がある企業。
- FedExコンパチブル プロバイダー:FedExコンパチブルプログラムを通じて契約上の合意を結んでいる認定企業。
- FedEx認定インテグレータープロバイダー: FedEx Integrator Program を通じて契約上の合意を得た、認定企業。
お客様のビジネスに最も近いオプションを以下から選択してください。ユーザーの種類に関わらず、ご利用を開始するためのガイドをご用意しています。
ご利用を開始するには、こちらを選択してください。
もし貴社に組織がない場合は、作成してください。あるいは、既存の組織に加入してください。
新しい組織を作成
ナビゲーションバーで「組織を作成または参加」をクリックします。
注:作成者として、お客様は自動的に組織管理者として指定されます。
管理者は以下の操作が可能です。
ユーザーを招待する
ユーザーに役割(例:投稿者、閲覧者)とプロジェクトを割り当てる
出荷アカウントを管理する
これらの役割の詳細については、組織管理ガイドをご覧ください。
会社種別として、FedExの技術を応用したソフトウェアソリューションを販売または提供し、かつFedEx認定インテグレータープロバイダーです」を選択してください。
貴社の社名、ウェブサイトURL、および固有の組織名を提供してください。組織名は、貴社の社名と一致させたり、特定のグループ(部署、部門、地域、場所)を表すことができます。この情報は、お客様のリクエストを検証するために必要です。
注:他のすべてのユーザーが認識できる組織名を選択してください(例:会社名、部署、地域、場所)。
貴社の所在地と、ソフトウェアソリューションが販売または流通される場所を指定してください。
請求先アカウントを追加し、アカウントを認証します。
注:FedEx認定インテグレータープログラムの出荷・物流プロバイダーとして、ご自身のアカウント・ナンバーを使用する必要があります。お客様のFedExアカウントはご利用いただけません。
フェデックス・アカウント・ナンバーを入力してください。既存のFedExアカウントをお持ちでない場合は、fedex.comで新規アカウントを開設するか、FedExサポート担当者にお問い合わせください。
アカウントのニックネームと、そのアカウントに関連付けられた請求先住所を入力してください。「次へ」を選択してください。
注:請求先住所は、当アカウントの登録情報と一致していなければなりません。これはお客様の組織のデフォルトの請求先アカウントとなります。
お客様の組織の作成を完了するには、アカウントの認証が必要です。「認証オプション」を選択してください(電話認証は米国およびカナダのインテグレーターのみ利用可能、メール、テキストメッセージ)。次に「次へ」を選択してください。
認証コードを受け取りましたら、入力して「送信」を選択してください。
利用規約に同意する
グローバルインテグレーター契約およびプログラムマニュアルをお読みください。利用規約に同意する場合は、チェックボックスを選択してから「同意する」をクリックしてください。
確認画面が表示されます。必要に応じて「組織を管理」をクリックして詳細を編集してください。
ユーザーの招待
注:ユーザーを招待できるのは管理者だけです。
左側のナビゲーションから「組織の管理」を選択してください。
「ユーザー」タブに移動し、「ユーザーを追加」を選択してください。
フォームに記入し、新規ユーザーに適切な役割(閲覧者、投稿者、または管理者)を割り当ててください。
ユーザーの役割の詳細については、組織管理ガイドを参照してください。
プロジェクト(該当する場合)にユーザーを割り当てるには、「プロジェクト」ドロップダウンメニューから選択します。
各ユーザーのメールアドレスを入力し、「招待」を選択してください。
既存の組織に参加
招待をリクエストする:お客様の組織の管理者に招待状を送ってもらってください。有効期限が切れる前に、24時間以内に承諾してください。必要であれば、管理者に再送を依頼してください。
招待の受け入れ:既存のユーザーIDとパスワードでログインしてください。IDが既に別の組織に紐付けられている場合は、新しいIDを作成する必要があります。
既存の組織に参加する
ステップ1:組織の管理者に招待状を送信するよう依頼します。
会社にすでに組織がある場合は、組織の管理者にあなたを招待するように依頼しましょう。招待の有効期間は送信から24時間以内となります。この期限が過ぎても招待を再送してもらうことができます。
ステップ2:招待状を受け入れます。
招待を受け入れるには、既存のユーザーIDとパスワードを使用してログインするか、既存のユーザーIDがすでに組織に関連付けられている場合は、新しいユーザーIDを作成する必要があります。
APIプロジェクトを作成
[マイプロジェクト]ページに移動し、[API]タブを開きます。[APIプロジェクトを作成]ボタンをクリックします。
ステップ1:プロジェクトに含めるAPIを選択します
APIクォータ、レート制限、およびAPI検証の詳細を確認します。
ステップ2:プロジェクトの詳細を設定します
- プロジェクトに、組織内で一意の識別可能な名前を付けます。
- 出荷予定の国を選択すると、テスト出荷アカウントが割り当てられす。ヨーロッパ国内で貨物をテスト出荷するには国ごとに別のテストアカウントを用意する必要があります。なお、国はいつでも追加または削除できます。
- 最新のAPIアップデートやサービス停止に関する情報を通知するには、通知設定を設定してください。
ステップ3:FedEx Developer Portalライセンス契約を含む利用規約を読み、同意します
利用規約に同意し、[作成]ボタンをクリックすると、確認画面が表示されます。その後、新しいプロジェクト内でテスト認証情報を確認できます。
Webhookプロジェクトを作成
宛先アプリケーションまたはプラットフォームで有効な(コールバック)URLを作成します
宛先URLは、FedExからの認証コード、メッセージ、およびWebhookペイロード通知の受信に使用されます。セキュリティを確保するため、URLはHTTPSを使用する必要があります。URLに以下の内容が含まれている場合、URLはブロックされます
- RFC1918 IPスペース
- fedex.comまたはそのサブドメインのいずれか
- URL内のIPアドレス(localhost、127.0.0.1を含む)
セキュリティトークンを生成する
このセキュリティトークンは、貴社とFedExの間で送信される情報を認証および検証するための秘密キーとして使用できます。セキュリティトークンには、以下の条件を満たす必要があります
- 26文字以上 100文字以下
- 大文字1文字
- 小文字1文字
- 数字1個
例:Y1F6OiVUQW2JPSElmRE9U0IY5
URLおよびセキュリティ・トークンを定義したら、Webhookプロジェクトを作成できます。[マイプロジェクト]ページに移動し、[Webhooks]タブを開きます。[Webhookプロジェクトを作成]ボタンをクリックします。
サブスクリプションのタイプを選択する
FedEx荷送人は、アカウント・ナンバーまたは追跡番号にイベントをサブスクライブできます。
ステップ1:請求先アカウントを確認し、機能を選択します
- 表示されているデフォルトの請求先アカウントを確認し、組織の別のアカウントを選択してください。
- 配達証明オプション、配達予定オプション、追跡イベント、イベントベースのフィルタリングなどの機能を選択して、プロジェクトを設定します。
ステップ2:プロジェクトの詳細を入力
- プロジェクトに、組織内で一意の識別可能な名前を付けます。
- 事前設定認証(上記のステップを参照)で作成した宛先URLおよびセキュリティトークンの詳細を入力します。
- 最新のWebhookの更新情報や、サービス停止に関する情報を受け取るには、Eメールアドレスとご希望の言語を入力してください。
ステップ3:利用規約を読む
FedEx Developer Portalライセンス契約および注文書を含む利用規約に同意し、[作成]ボタンをクリックすると、確認画面が表示されます。
ご契約の種類によっては、追加のステップが必要になる場合があります。詳細については、ドキュメントをご覧ください。
[APIプロジェクトの概要]ページで、[テストキー]タブからテスト資格情報(APIキー、シークレットキー、配送アカウント)を取得します。
ステップ1:OAuthアクセストークンのリクエスト
OAuthアクセストークンは、各APIトランザクションで必須です。トークンは1時間のみ有効のため、セッションが切れる前にトークンをリフレッシュするようにアプリケーションをプログラムで実装する必要があります。詳細については、API Authorizationドキュメントを参照してください。
ステップ2:APIドキュメントを確認する
各APIのドキュメントをクリックして、ビジネス コンテキストを確認し、APIの使用方法を理解してください。「ドキュメント」ページの最上部のボタンからJSON APIコレクションをダウンロードするためにログインしてください。ご希望の統合に一致するエンドポイントのサンプルリクエストを確認することもできます。
ステップ3:サンドボックスでサンプルトランザクションをテストする
左側のナビゲーションで目的のエンドポイントをクリックして、その特定のサンドボックスに移動します。ユースケースに一致するサンプルリクエストを特定し、テスト認証情報とFedExテストURLを使用して、サンプルリクエストの説明に従ってエンドポイントへの呼び出しを実装します。受け取ったAPI呼び出しの応答が、ドキュメントに表示されているものと一致することを確認します。サンドボックスの仮想化ガイドで、FedExのテスト体験について詳しくご確認ください。
Webhookを使用したテスト
テストを行うと、作成したURLが有効であるかどうかを判断するのに役立ちます。これにより、FedExはお客様のURLを識別し、お客様のURLとの接続を確立してデータを送信することができます。また、テストでは、アプリケーションで提供された追跡データを処理できるかどうかを確認および確認するのに役立つサンプルテストデータも提供されます。ただし、テストではお客様のURLの認証は行われません。Webhookのドキュメントで、Webhook URLをテストする方法をご確認ください。
[プロジェクトの概要]ページに移動し、[プロダクションキー]タブを開きます。Advanced Integrated Visibilityアカウント・ナンバー サブスクリプションプロジェクトは、本番環境に移行する必要はありません。
ステップ1:プロジェクトの設定
- 必要に応じて、キーの名前を変更します。
- プロジェクト作成フローの手順1で選択したアカウント・ナンバーを確認します。これは、プロジェクトを実稼働環境に移行するために使用されます。プロジェクトが運用環境で稼働すると、必要に応じてアカウントを追加できます。
ステップ2:プロジェクトキーを取得する
Production APIキーとプロダクションシーレットキーを安全な場所にコピーしてください。プロダクションシーレットキーのセキュリティを確保するため、このキーは一度だけ表示されます。紛失した場合、新しいキーを生成できます。
プロジェクト キーを取得し[次へ]をクリックすると、[プロダクションキー]タブにプロジェクトの詳細が表示されます。
- プロジェクトに追加の配送アカウントを追加するには、配送アカウント テーブルの上部にある[編集]をクリックしてください。
APIの中にはFedExの本番環境で使用するため、出荷ラベル検証のいずれかを必要とするものがあります。APIが検証を必要とするかどうかを確認してください。
ステップ1:ウェブ対応アプリケーションでFedEx APIの開発とテストを実行
ウェブ対応アプリケーションの開発が完了したら、テスト認証情報(テスト出荷アカウント、APIキー、秘密キー)を使用してテストを完了させます。テストAPIキーと秘密キーは、プロジェクト概要ページに表示され、いつでも見ることができます。
ステップ2:プロジェクトを実稼働に移行します。
FedEx APIでテストを行った後は、FedEx Developer Portalでプロジェクトを実稼働環境に移行して検証プロセスを開始する必要があります。無事に完了すると、実稼働APIキーと秘密キーが表示されます。実稼働秘密キーは一度しか見ることができませんが、後で再生成することができます。
ステップ3:ラベルカバーシートに記入します。
ラベルカバーシートに、適切な連絡先情報と実装する予定のサービスについて、必要事項をすべて記入してください。アカウント・ナンバーとプロダクションキーも記入してください。
ステップ4:テストラベルを生成し、バーコード分析担当グループに提出する
アプリケーションに関連付けられたFedExテスト環境でテストラベルを作成し、FedExラベル評価チームに提出して承認を得てください。バーコード分析グループでは、ラベルの評価に3営業日かかります。
処理の遅延を避けるため、以下のベストプラクティスに従ってください
- ラベルは最低600DPI以上で印刷し、スキャンする必要があります。APIで生成されたファイルを送信しないでください。
- サーマルプリンタの場合は、プリンタの機種に応じてラベルイメージの種類をリクエストする必要があります。例: ゼブラプリンター用ZPLII。
- 評価用サンプルラベルを作成する際には荷送人/荷受人の住所情報を使用します。適用する特定のサービスのサンプルラベルのみを作成します。
- FedEx® 着払い(C.O.D.)ラベルには、対応するC.O.D.返送ラベルを含める必要があります。
- FedEx International Express®貨物には、補助/二次航空運送状(AWB)ラベルも貼付する必要があります。
- 複数個口貨物(MPS)では、貨物中の各パッケージに1つのラベルを添付する必要があります。
- PDFおよびラベルカバーシートをlabel@fedex.com宛てにEメールで送信してください。
- 物理的なラベルを、以下の住所に送付することもできます。
FedEx Services
WTC-Business Solutions Testing
10 FedEx Parkway
2nd Floor Horizontal
Collierville, TN 38017
スキャンしたラベルに目に見える欠陥(バーコードに重なった線、インクの斑点、物理的な損傷など)がなければ、検査に合格し、承認されます。
実際のラベルを送る場合は、印刷品質やラベルの偶発的な拡大・縮小に注意してください。(例: スケーリング)これらはラベル評価が失敗する理由のうち最も顕著な2例です。
ステップ5:ラベルの評価を確認
バーコード分析グループは、提出されたテストラベルを評価し、ラベルを承認または拒否します。提出されたラベルの承認または拒否については、バーコード分析グループから連絡があります。ラベルが承認された場合は、次のステップに進みます。ラベルが拒否された場合は、指示通りにラベルを修正し、承認のために再提出してください。
ステップ6:アプリケーションを有効にする
バーコード分析グループによってテストラベルが生産ステータスとして承認されると、識別された出荷ラベルのトランザクションを送信するための生産検証情報が承認され、検証の成功がEメールで通知されます。承認はプロジェクトごとに必要です。
ステップ7:URLと資格情報の置換え
テストURLとテスト資格情報を実稼働用URLと実稼働用資格情報に置換えます。 サンプルデータを使用して実稼働環境での実装を再テストします。
ステップ1:組織への参加招待を受け取る
FedExが組織を作成し、チームメンバーを1名組織に招待します。このユーザーは、組織の管理者として指定されます。
ステップ2:招待を受け入れる
招待を受け入れるには、既存のユーザーIDとパスワードを使用してログインするか、既存のユーザーIDがすでに組織に関連付けられている場合は、新しいユーザーIDを作成する必要があります。
ステップ3:ユーザーを招待する
管理者はユーザーを組織に招待し、役割やプロジェクトに割り当てることができます。[ユーザー]タブを開きます。[ユーザーの追加]ボタンをクリックします。
- ユーザーの役割(閲覧者、コントリビューター、管理者)を選択します。役割の詳細については、組織管理ガイドをご覧ください。
- ユーザーの役割(閲覧者、寄稿者、管理者)を選択します。また、[プロジェクトの概要]ページで、ユーザーをプロジェクトに割り当てることもできます。
- 選択した役割で組織に参加させたいユーザーのEメールアドレスを入力します。
APIカタログにアクセスして、お客様のソリューションに適したAPIまたはWebhookを決定してください。FedExカスタマーテクノロジーコンサルタント(CTC)および互換チャネルマネージャーが、お客様のビジネスニーズに合ったソリューションに最適なAPIを選択するお手伝いをいたします。
ステップ1:PIWに記入する
互換プロバイダーコミュニティ(CPC)に戻り、製品情報ワークシート(PIW)に記入してください。
ステップ2:FedExが作成したプロジェクトを確認する
PIWが承認されますと、FedExがプロジェクトを作成します。お客様のソリューションの各バージョンには、FedEx Developer Portal上に個別のプロジェクトが作成されます。
ステップ3:チームでAPIデモに参加する
FedEx互換チーム、FedExCTC、および検証チームが、お客様のチーム向けにAPIの技術デモを開催します。FedExチームが、互換プログラム検証、新しいAPIの特徴と機能についてご説明し、ご質問にお答えします。
[APIプロジェクトの概要]ページで、テスト用の資格情報(APIキーとシークレットキー)を[テストキー]タブから取得します。
ステップ1:カスタマーキーの作成
Credential Registration APIを使用して、カスタマーキーを作成してください。これは、[APIプロジェクトの概要]ページの最下部にあるAPIセクションにのみ存在するプライベートAPIです。
ステップ2:OAuthアクセストークンのリクエスト
OAuthアクセストークンは、各APIトランザクションで必ず使用する必要があります。トークンのセッションは1時間だけ有効なため、セッションの有効期限が切れる前にアプリケーションがトークンを更新するようにプログラムでコーディングしなければなりません。詳細については、API Authorizationドキュメントを参照してください。サンプルコードを表示する際は、サンプルドロップダウンから[再販業者]が選択されていることを確認してください。
ステップ3:APIドキュメントを確認する
各APIのドキュメントをクリックして、ビジネス コンテキストを確認し、APIの使用方法を理解してください。「ドキュメント」ページの最上部のボタンからJSON APIコレクションをダウンロードするためにログインしてください。ご希望の統合に一致するエンドポイントのサンプルリクエストを確認することもできます。
ステップ4:サンドボックスを使用してサンプルトランザクションをテストする
左側のナビゲーションで目的のエンドポイントをクリックして、その特定のサンドボックスに移動します。お客様のユースケースに一致するサンプルリクエストを特定し、テスト認証情報とFedExテストURLを使用して、サンプルリクエストの説明に従ってエンドポイントへの呼び出しを実装します。受け取ったAPI呼び出しのレスポンスがドキュメントに示されているものと一致していることを確認してください。サンドボックスの仮想化ガイドで、FedExのテスト体験について詳しくご確認ください。
ステップ5:各ソリューションを確認する
ソリューションを完全にテストしたら、テストケースを検証チームに提出して、各ソリューションを検証してください。FedExは、提出されたすべてを完全に確認し、検証が承認されたらお客様にご連絡いたします。
Webhookを使用したテスト
組織がWebhookへのアクセス権を持っている場合、テストを行うことで、作成したURLが有効であるかどうかを判断するのに役立ちます。これにより、FedExがURLを識別し、URLとの接続を構築してデータを送信できるようになります。テストでは、アプリケーションで提供される追跡データを処理できるかどうかを確認および検証するのに役立つサンプルテストデータも提供されます。ただし、テストではURLは認証されません。Webhook URLをテストする方法については、Webhookのドキュメントをご確認ください。
その後、FedExはプロジェクトを本番環境に移行します。[APIプロジェクトの概要]ページにアクセスし、[プロダクションキー]タブを開きます。[シークレットキー]列の下にある[シークレットキーを生成]リンクをクリックします。
これで、サンプルデータを使用して実稼働環境での実装を再テストすることができます。
会社の既存の組織に参加するか、組織が会社にまだ存在しない場合は組織を作成します。
新しい組織を作成する
ナビゲーションバーで「組織を作成または参加」をクリックします。
注:作成者として、お客様は自動的に組織管理者として指定されます。
管理者は以下の操作が可能です。
ユーザーを招待する
ユーザーに役割(例:投稿者、閲覧者)とプロジェクトを割り当てる
出荷アカウントを管理する
これらの役割の詳細については、組織管理ガイドをご覧ください。
会社種別については、「FedExの技術を使用したソフトウェアソリューションを販売または提供し、かつFedEx認定インテグレータープロバイダーである」を選択してください。
貴社の社名、ウェブサイトURL、および固有の組織名を提供してください。組織名は、貴社の社名と一致させたり、特定のグループ(部署、部門、地域、場所)を表すことができます。この情報は、お客様のリクエストを検証するために必要です。
注:他のすべてのユーザーが認識できる組織名を選択してください(例:会社名、部署、地域、所在地)。
貴社の所在地と、ソフトウェアソリューションが販売または流通される場所を指定してください。
請求先アカウントを追加し、アカウントを認証します。
注:FedEx認定インテグレータープログラムの出荷・物流プロバイダーとして、ご自身のアカウント・ナンバーを使用する必要があります。お客様のFedExアカウントはご利用いただけません。
フェデックス・アカウント・ナンバーを入力してください。既存のFedExアカウントをお持ちでない場合は、fedex.comで新規アカウントを開設するか、FedExサポート担当者にお問い合わせください。
アカウントのニックネームと、そのアカウントに関連付けられた請求先住所を入力してください。「次へ」を選択してください。
注:請求先住所は、当アカウントの登録情報と一致していなければなりません。これはお客様の組織のデフォルトの請求先アカウントとなります。
お客様の組織の作成を完了するには、アカウントの認証が必要です。「認証オプション」を選択してください(電話認証は米国およびカナダのインテグレーターのみ利用可能、メール、テキストメッセージ)。次に「次へ」を選択してください。
認証コードを受け取りましたら、入力して「送信」を選択してください。
利用規約に同意する
FedEx認定インテグレーター契約およびプログラムマニュアルをお読みください。利用規約に同意する場合は、チェックボックスを選択してから「同意する」をクリックしてください。
確認画面が表示されます。必要に応じて「組織を管理」をクリックして詳細を編集してください。
ユーザーの招待
注:ユーザーを招待できるのは管理者だけです。
左側のナビゲーションから「組織の管理」を選択してください。
「ユーザー」タブに移動し、「ユーザーを追加」を選択してください。
フォームに記入し、新規ユーザーに適切な役割(閲覧者、投稿者、または管理者)を割り当ててください。
ユーザーの役割の詳細については、組織管理ガイドを参照してください。
プロジェクト(該当する場合)にユーザーを割り当てるには、「プロジェクト」ドロップダウンメニューから選択します。
各ユーザーのメールアドレスを入力し、「招待」を選択してください。
既存の組織に参加
招待をリクエスト:お客様の組織の管理者から招待状をお受け取りいただけますようお願いいたします有効期限が切れる前に、24時間以内に承諾してください。必要であれば、管理者に再送を依頼してください。
招待の受け入れ:既存のユーザーIDとパスワードでログインしてください。IDが既に別の組織に紐付けられている場合は、新しいIDを作成する必要があります。
APIプロジェクトを作成
「マイプロジェクト」ページに移動し、「プロジェクトの作成」を選択してください。
「プロジェクト名」フィールドに入力してください。推奨される名前形式は「プロジェクト名_アプリケーション名」です。完了したら「次へ」を選択してください。
プロジェクト向けにAPIおよびAdvanced Integrated Visibility製品を選択してください。
注: Advanced Integrated Visibility 製品は、米国FedEx認定インテグレータープロバイダーのみが利用可能です。
注:有料製品を選択した場合、プロジェクトに請求先アカウントを割り当て、必要な利用規約に同意するよう求められます。
請求を割り当て、条件を受け入れる 請求書の発行と条件の承諾
組織に追加されたアカウントのリストから請求先アカウントを割り当てます。この手順は、以前に有料製品を選択した場合にのみ必要です。
製品に関連する利用規約に同意します。
詳細を確認
選択した製品を確認してください。提供された請求先アカウントを確認してください。
FedEx Developer Portal利用規約を確認し、同意してください。
「作成」をクリックしてプロジェクトを生成し、テスト認証情報を表示します。
プロジェクトでAdvanced Integrated Visibilityを設定
前提条件
仕向地アプリケーションまたはプラットフォームで有効なコールバックURLを作成 – アプリケーション/プラットフォームのURL:
セキュリティのため、必ずHTTPSを使用してください。
RFC1918 IPアドレス空間、fedex.comのサブドメイン、または直接IPアドレス(例:127.0.0.1)を含めることはできません。
セキュリティトークンを生成する
26~100文字の長さで、以下を含める必要があります。
- 1つの大文字
- 1つの小文字
- 1つの数数字
例:Y1F6OiVUQW2JPSElmRE9U0IY5
Advanced Integrated Visibilityを構成
「Advanced Integrated Visibility」を選択してください。配達証明、配達予定日、追跡イベント、イベントベースのフィルタリングなどの機能を選択してください
宛先URLとセキュリティトークンを入力してください。
Advanced Integrated Visibilityの更新情報と障害通知を受け取るためのメールアドレスを提供してください。
詳細を確認
FedEx Developer Portal利用許諾契約および注文書を確認し、同意してください。
「作成」を選択して設定を完了してください。
注:サブスクリプションの種類によっては、追加の手順が必要になる場合があります。詳細はドキュメントを参照してください。
テスト認証情報を取得してテストを開始
APIドキュメントを確認
- APIドキュメントをお読みいただき、当社が提供する各種APIとそのビジネス上の背景、統合プロセスについてご理解ください。
- 関連する「APIのドキュメント」ページから「JSONスキーマ」をダウンロードしてください。
- 希望するエンドポイントに対するリクエスト例を確認してください。
テスト認証情報を取得
「プロジェクト概要」ページで、「APIキー」タブに移動します。APIキーとシークレットキーは、「テストキー」の見出しの下に記載されています。
APIドキュメントを確認
- すべてのAPI取引にはOAuthトークンが必要であり、その有効期限は1時間です。
- アプリケーションはトークンの有効期限が切れる前に更新する必要があります。
- 詳細については、API Authorizationドキュメントを参照してください。
サンドボックス環境でAPI取引をテスト
- 「APIカタログ」内の該当するAPIに移動し、「ドキュメント」を選択してください。
- 左側のメニューから目的の「APIエンドポイント」を選択してください。
- ユースケースに合ったサンプルリクエストを使用してください。
- テスト認証情報とFedExテストURLを使用してAPI呼び出しを実装してください。
- ドキュメントと照らして回答を確認してください。
- 詳細はサンドボックス仮想化ガイドを参照してください。
Advanced Integrated Visibilityのテスト
Advanced Integrated Visibilityテストは、お客様のURL形式を検証し、FedExとお客様のアプリケーション間の接続確立を支援します。
このテストは、追跡情報の処理のためのサンプルテストデータを提供します。
注:テストはお客様のURLを認証しません。
詳細については、Advanced Integrated Visibility のドキュメントをご覧ください。
APIを本番環境に移行するには検証が必要です。検証のレベルはAPIによって異なります。
FedEx APIの開発とテスト
- 「プロジェクト概要」ページから取得した「テスト認証情報」(APIキーとシークレットキー)を使用してください。
- ソリューションを展開する予定の地域/領域におけるテストケースを特定してください(インテグレーター テストケース ベースラインを参照)。
- テストケースを実行する前に、提供されたテストアカウント・ナンバーを使用して登録取引を完了してください。
- 必要なすべてのテストケースを実行してください。
「プロジェクト概要」ページに移動してください。
「実稼働キーをリクエスト」を選択してください。FedExが実稼働キーの発行依頼を受け付け、承認され次第通知されます。
完全なPIWおよび検証カバーシート
製品情報ワークシート(PIW)およびインテグレーター検証カバーシートに、連絡先情報とご利用予定のFedExサービスを記入してください。
成果物の送信
以下のファイルを収集し、.zipファイルに圧縮して、メールプロバイダの制限を回避してください。validationmtp@fedex.com 宛に送信してください。
必須成果物
- 完了済み PIW(PDF)
- 完了済み検証カバーシート(PDF)
スクリーンショット(PDF):
FedExサービス/特別取扱いを表示した顧客向けソリューション
免責事項
EULA契約
エンドユーザー登録フロー
- エンドユーザー登録取引(多要素認証付き)(JSON)
- 該当するすべてのテストケースのスキャン済み出荷ラベル(PDF/PNG)
- 3種類のラベル形式(PDF、PNG、ZPL(JSON))の出荷取引(該当する出荷および料金API向け)
遅延を避けるためのベストプラクティス
- ラベルは最低600 DPIで印刷およびスキャンする必要があります。
- サーマルプリンタ用ラベルはプリンタモデルに適合する必要があります(例:Zebraプリンタ用ZPLII)。
- FedEx International Express®の貨物は、補助航空貨物運送状(AWB)ラベルが必要です。
- 複数個口貨物(MPS)には、各個別のパッケージごとにラベルを貼付する必要があります。
ラベル評価
検証チームは、お客様の提出物を承認または却下します。
- 却下された場合は、フィードバックに基づいて修正を加え、再提出してください。
- 承認された場合、検証が正常に完了したことを確認するメールが届きます。メールを受信後、お客様の実稼働認証情報が出荷ラベル取引に対して承認されます。
検証後の手順に従う
必要に応じて、検証後の要件を確認し、実装してください。
実稼働キーが承認された旨の通知を受け取りましたら、「プロジェクト概要」タブから実稼働キーを取得してください。
- 実稼働API キーとシークレットキーをコピーして安全に保管してください。
- シークレットキーは一度だけ表示されます。紛失した場合は、新しいものを再生成する必要があります。

