Getting started
FedEx Developer Portalは、FedExをアプリケーションに統合するための一連のアプリケーション・プログラミング・インターフェース（API）を提供しています・この説明は、組織の設定、プロジェクトの作成、統合のテスト、プロジェクトを本番環境に移行するステップ、および場合によってはAPIの認証を行うステップについてご説明します。
ユーザーの種類：
FedExは、3種類のユーザーに統合サービスを提供しています。FedEx荷送人、FedExコンパチブル プロバイダーとして認定されたソフトウェアソリューション、および非コンパチブル プロバイダーです。
FedEx荷送人：
FedExを利用して出荷を行い、FedEx APIを自社のアプリケーションに統合する必要がある企業。
ソリューションまたはサービスプロバイダー：
FedEx APIを統合して、FedExを利用して出荷を行う外部組織に販売および／または配布できるソリューション、アプリケーション、またはプラグインを構築する必要がある企業。FedExのグローバルディレクトリを検索して、貴社が認定FedExプロバイダーであるかどうかをご確認ください。
- FedExコンパチブル プロバイダー：FedExコンパチブルプログラムを通じて契約上の合意を結んでいる認定企業。
- 非コンパチブルプロバイダー：ソリューションまたはサービスがFedExコンパチブルプログラムによって検証されていない。
お客様のビジネスに最も近いオプションを以下から選択してください。ユーザーの種類に関わらず、ご利用を開始するためのガイドをご用意しています。
- FedEx Shipper: Company who integrates FedEx APIs into their own applications.
- FedEx Compatible Provider: Company certified by the FedEx Compatible program who integrates with FedEx APIs to build a solution, application or plugin that can be sold and/or distributed to an external organization.
- Non-Compatible Provider: Company who integrates with FedEx APIs to build a solution, application or plugin that can be sold and/or distributed to an external organization.
Prerequisite
You must have a FedEx user ID to log into the FedEx Developer Portal and create an organization.
貴社にまだ組織が存在しない場合は、組織を作成するか、貴社の既存の組織に加わってください。
新しい組織を作成する
独自の組織を作成するには、左側のナビゲーションで［組織の作成］をクリックします。組織を作成すると、その組織の管理者として自動的に登録されます。
- 管理者は、ユーザーを組織に招待し、役割（コントリビューター、閲覧者など）やプロジェクトを割り当て、出荷アカウントを管理することができます。
- これらの役割の詳細については、組織管理ガイドラインをご覧ください。
組織情報の提供
会社名、WebサイトのURLを入力し、組織名を作成します。他のユーザーが認識できる名前を組織につけます。この名前は、お客様の会社をさらに細かいグループに組織分けするのに使用することができたり（例：部、課、地域、所在地）または会社名と同じにすることもできます。
組織を作成したら、管理者として左側のナビゲーションから［組織の管理］をクリックして、詳細情報を入力してください。
出荷アカウントの追加
［出荷アカウント］タブを開きます。［アカウントを追加］ボタンをクリックします。
- 既存のフェデックス・アカウント・ナンバー、アカウントのニックネーム、およびアカウントに登録されている請求先住所を入力してください。不正行為を防止するため、請求先住所がアカウントの詳細と一致していることを確認します。フェデックス・アカウントをお持ちでない場合は、新しいアカウントを開設するか、FedExカスタマーサービス担当者にお問い合わせください
- エンドユーザーライセンス契約に同意するか、契約に同意する権限のある社内の担当者に送信してください。
請求先アカウントの追加
［請求先アカウント］タブを開きます。［組織に請求先アカウントを追加］ボタンをクリックします。
- 既存のフェデックス・アカウント・ナンバー、アカウント・ニックネーム、およびアカウントに関連付けられている米国での請求先住所を入力します。不正行為を防止するため、請求先住所がアカウントの詳細と一致していることを確認します。フェデックス・アカウントをお持ちでない場合は、新しいアカウントを開設するか、FedExカスタマーサービス担当者にお問い合わせください。請求先アカウントは米国にある必要があります。
- エンドユーザーライセンス契約に同意するか、契約に同意する権限のある社内の担当者に送信してください。
ユーザーの招待
管理者は、ユーザーを組織に招待し、役割やプロジェクトを割り当てることができます。［ユーザー］タブを開きます。［ユーザーの追加］ボタンをクリックします。
- ユーザーの役割（閲覧者、コントリビューター、管理者）を選択します。
- ユーザーの役割（閲覧者、寄稿者、管理者）を選択します。また、［プロジェクトの概要］ページで、ユーザーをプロジェクトに割り当てることもできます。
- 選択した役割で組織に参加させたいユーザーのEメールアドレスを入力します。
既存の組織に参加する
ステップ1：組織の管理者に招待状を送信するよう依頼します。
会社にすでに組織がある場合は、組織の管理者にあなたを招待するように依頼しましょう。招待の有効期間は送信から24時間以内となります。この期限が過ぎても招待を再送してもらうことができます。
ステップ2：招待状を受け入れます。
招待を受け入れるには、既存のユーザーIDとパスワードを使用してログインするか、既存のユーザーIDがすでに組織に関連付けられている場合は、新しいユーザーIDを作成する必要があります。
APIプロジェクトを作成
［マイプロジェクト］ページに移動し、［API］タブを開きます。［APIプロジェクトを作成］ボタンをクリックします。
ステップ1：プロジェクトに含めるAPIを選択します
APIクォータ、レート制限、およびAPI Authorizationの詳細を確認します。
ステップ2：プロジェクトの詳細を設定します
- プロジェクトに、組織内で一意の識別可能な名前を付けます。
- 出荷予定の国を選択すると、テスト出荷アカウントが割り当てられす。ヨーロッパ国内で貨物をテスト出荷するには国ごとに別のテストアカウントを用意する必要があります。なお、国はいつでも追加または削除できます。
- 最新のAPIアップデートやサービス停止に関する情報を通知するには、通知設定を設定してください。
ステップ3：FedEx Developer Portalライセンス契約を含む利用規約を読み、同意します
利用規約に同意し、［作成］ボタンをクリックすると、確認画面が表示されます。その後、新しいプロジェクト内でテスト認証情報を確認できます。
Webhookプロジェクトを作成
Prerequisites
- Review pricing: subscribers are charged a monthly fee based on the count of track numbers. Refer to the Pricing Guide to learn more about pricing.
- Set up accounts: Advanced Integrated Visibility webhook requires a U.S.-based billing account and at least one shipping account, these two account types are mutually exclusive. Only admins can add billing and shipping accounts on the Manage Organization page.
宛先アプリケーションまたはプラットフォームで有効な（コールバック）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キーとプロダクションシーレットキーを安全な場所にコピーしてください。プロダクションシーレットキーのセキュリティを確保するため、このキーは一度だけ表示されます。紛失した場合、新しいキーを生成できます。
プロジェクト キーを取得し［次へ］をクリックすると、［プロダクションキー］タブにプロジェクトの詳細が表示されます。
- プロジェクトに追加の配送アカウントを追加するには、配送アカウント テーブルの上部にある［編集］をクリックしてください。
Certification steps vary by region
The following steps apply only for customers in the US and Canada. If you live outside of these countries, visit the API Certification page to find support.
一部の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と実稼働用資格情報に置換えます。 サンプルデータを使用して実稼働環境での実装を再テストします。
Prerequisite
Your business must be an existing FedEx Compatible provider. If your business is not in the Compatible program, then change your selection above to “Non-Compatible Provider.”
ステップ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プロジェクトの概要］ページにアクセスし、［プロダクションキー］タブを開きます。［シークレットキー］列の下にある［シークレットキーを生成］リンクをクリックします。
これで、サンプルデータを使用して実稼働環境での実装を再テストすることができます。
Prerequisite
You must have a FedEx user ID and account to log into the FedEx Developer Portal and create an organization.
会社の既存の組織に参加するか、組織が会社にまだ存在しない場合は組織を作成します。
新しい組織を作成する
独自の組織を作成するには、左側のナビゲーションで［組織の作成］をクリックします。組織を作成すると、その組織の管理者として自動的に登録されます。
- 管理者は、ユーザーを組織に招待し、役割（例：コントリビューター、閲覧者など）およびプロジェクトを割り当てることができます。
- これらの役割の詳細については、組織管理ガイドをご覧ください。
ステップ1：組織情報の入力
- 確認のために、会社名、ウェブサイトのURL、およびビジネス用Eメールアドレスを入力してください。
- 組織名を作成してください。他のユーザーが認識できる名前を組織につけます。この名前は、お客様の会社をさらに細かいグループに組織分けするのに使用することができたり（例：部、課、地域、所在地）または会社名と同じにすることもできます。
- 会社の所在地、およびソフトウェアソリューションの販売または配布を予定している場所の情報を入力してください。
ステップ2：アカウントの追加と認証
既存のフェデックス・アカウント・ナンバー、アカウントのニックネーム、およびアカウントに登録されている請求先住所を入力してください。不正行為を防止するため、請求先住所がアカウントの詳細と一致していることを確認します。フェデックス・アカウントをお持ちでない場合は、新しいアカウントを開設するか、FedExカスタマーサービス担当者にお問い合わせください
- FedEx Integrator Programに参加するサードパーティプロバイダーとして、この初期登録に使用するアカウントは、インテグレーターであるお客様自身のものである必要があります。エンドカスタマーのアカウントを使用することはできません。
- このアカウントは、お客様の組織のデフォルトの請求先アカウントとして設定されます。
ステップ3：利用規約を読む
開発者契約およびプログラムマニュアルに同意すると、確認画面が表示されます。新しい組織の管理者として、左側のナビゲーションから［組織の管理］をクリックして、詳細を表示または編集することができます。
ステップ4：ユーザーを招待する
管理者は、ユーザーを組織に招待し、役割やプロジェクトを割り当てることができます。［ユーザー］タブを開きます。［ユーザーの追加］ボタンをクリックします。
- ユーザーの役割（閲覧者、コントリビューター、管理者）を選択します。
- 既存のプロジェクトがある場合は、ユーザーにプロジェクトを割り当てます。［プロジェクトの概要］ページでも、プロジェクトにユーザーを割り当てることができます。
- 選択した役割で組織に参加させたいユーザーのEメールアドレスを入力します。
既存の組織に参加する
ステップ1：組織の管理者に招待状を送信するよう依頼します。
会社にすでに組織がある場合は、組織の管理者にあなたを招待するように依頼しましょう。招待の有効期間は送信から24時間以内となります。この期限が過ぎても招待を再送してもらうことができます。
ステップ2：招待状を受け入れます。
招待を受け入れるには、既存のユーザーIDとパスワードを使用してログインするか、既存のユーザーIDがすでに組織に関連付けられている場合は、新しいユーザーIDを作成する必要があります。
［マイプロジェクト］ページに移動し、APIタブを開きます。［APIプロジェクトを作成］ボタンをクリックしてください。
ステップ1：プロジェクトに含めるAPIを選択します
［出荷］［料金］その他のAPIクォータ、レート制限、API Authorizationの詳細を確認してください。
- ShipまたはOpen Ship APIを選択した場合、Service Availability APIとTrade Documents Upload APIが自動的に選択されます。これらはShipまたはOpen Ship APIを使用する際の必須APIです。
ステップ2：プロジェクトの詳細を設定します
プロジェクトに、組織内で一意の識別可能な名前を付けます。
ステップ3：FedEx Developer Portalライセンス契約を含む利用規約を読み、同意します
利用規約に同意し、［作成］ボタンをクリックすると、確認画面が表示されます。その後、新しいプロジェクト内でテスト認証情報を確認できます。
Webhookプロジェクトを作成
Prerequisites
- Review pricing: subscribers are charged a monthly fee based on the count of track numbers. Refer to the Pricing Guide to learn more about pricing.
- Set up accounts: Shipment Visibility webhook requires a U.S.-based billing account and at least one shipping account, these two account types are mutually exclusive. Only admins can add billing and shipping accounts on the Manage Organization page.
宛先アプリケーションまたはプラットフォームで有効な（コールバック）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を使用したテスト
組織がWebhookへのアクセス権を持っている場合、テストを行うことで、作成したURLが有効であるかどうかを判断するのに役立ちます。これにより、FedExがURLを識別し、URLとの接続を構築してデータを送信できるようになります。テストでは、アプリケーションで提供される追跡データを処理できるかどうかを確認および検証するのに役立つサンプルテストデータも提供されます。ただし、テストではURLは認証されません。Webhook URLをテストする方法については、Webhookのドキュメントをご確認ください。
［プロジェクトの概要］ページに移動し、［プロダクションキー］タブを開きます。Advanced Integrated Visibilityアカウント・ナンバー サブスクリプション・プロジェクトは、本番環境に移行する必要はありません。
ステップ1：プロジェクトの設定
必要に応じて、キーの名前を変更します。
ステップ2：プロジェクトキーを取得する
Production APIキーとプロダクションシーレットキーを安全な場所にコピーしてください。プロダクションシーレットキーのセキュリティを確保するため、このキーは一度だけ表示されます。紛失した場合、新しいキーを生成できます。
プロジェクトキーを取得し［次へ］をクリックすると、［プロダクションキー］タブにプロジェクトの詳細が表示されます。
Certification steps vary by region
The following steps apply only for customers in the US and Canada. If you live outside of these countries, visit the API Certification page to find support.
APIの中にはFedExの本番環境で使用するため、出荷ラベル認証のいずれかを必要とするものがあります。APIが認証を必要とするかどうかを確認してください。
ステップ1：ウェブ対応アプリケーションでFedEx APIの開発とテストを実行
ウェブ対応アプリケーションの開発が完了したら、テスト資格情報（テストAPIキーとシークレットキー）を使用してテストを完了してください。テストAPIキーとシークレットキーは、［プロジェクト概要］ページに表示され、いつでも見ることができます。
- ソリューションの検証および導入を行う地域／地域に関するすべてのテストケースを特定します。テストケースは、Integratorテストケースのベースラインに記載されています。
- テストケースを実行する前に、テストケースのベースラインに記載されている各テストアカウント・ナンバーの登録トランザクションを実行する必要があります。
- 次に、ソリューションの検証および導入を行う地域／地域に関するすべてのテストケースを実行します。
ステップ2：PIWと検証カバーシートを記入
製品情報シート（PIW）とインテグレーター検証カバーシートに、適切な連絡先情報および提供するサービスと機能を入力してください。
ステップ3：デリバブルを生成し、検証チームに提出
以下のデリバブルを収集し、.zipファイルに圧縮し、validationmtp@fedex.com宛てにEメールで送信してください。Eメールプロバイダによって送信がブロックされるリスクを軽減するため、ファイルは.zipファイルでEメールを送信することをお勧めします。
- 指定したすべての地域／地域に関するPIW（PDF形式）
- 検証カバーシート（PDF形式）
- 以下のスクリーンショット（PDF形式）
- FedExサービス／特別取扱いを表示した顧客向けソリューション
- 免責事項
- EULA契約
- エンドユーザー登録フロー
- エンドユーザー登録トランザクション — SMS、電話、Eメールによる請求書およびPINを含む多要素認証（フォーマット：JSONリクエスト／レスポンスファイル）
- テストケースのベースラインに含まれるすべてのテストケースに対応する、検証対象地域における実際の印刷済みラベルのスキャンコピー（形式：PDFまたはPNG）
- 3つのテストケースの出荷トランザクション（各ラベル画像タイプごとに1件：PDF、PNG、ZPL）（形式：JSONリクエスト／レスポンスファイル）
処理の遅延を避けるため、以下のベストプラクティスに従ってください
- ラベルは最低600DPI以上で印刷し、スキャンする必要があります。
- サーマルプリンタの場合は、プリンタの機種に応じてラベルイメージの種類をリクエストする必要があります。例: ゼブラプリンター用ZPLII。
- FedEx International Express®貨物には、補助／二次航空運送状（AWB）ラベルも貼付する必要があります。
- 複数個口貨物（MPS）では、貨物中の各パッケージに1つのラベルを添付する必要があります。
ステップ4：ラベル評価のレビュー
検証チームは提出された成果物を評価し、承認または却下します。検証チームは、提出物の承認または却下についてご連絡いたします。成果物が承認された場合、次のステップに進んでください。成果物が却下された場合、指示に従ってトランザクション、画面、および／またはラベルを修正し、再提出してください。
ステップ5：アプリケーションの有効化
検証チームにより、すべての納品物が生産段階への承認を受けた後、彼らは指定された出荷ラベルトランザクションを送信するための生産アクセス権限を付与し、認証完了をメールで通知します。ご承認はプロジェクトごとに個別に必要となります。
ステップ6：検証後のステップに従ってください
検証後のステップを確認し、必要に応じて従ってください。
