开始
FedEx Developer Portal 提供一套应用程序编程接口 (API)，可将 FedEx 服务集成至您的应用程序中。本指南将引导您完成以下操作：创建组织、新建项目、测试集成方案、将项目迁移至生产环境，以及（部分情况下）完成 API 验证。
用户类型：
FedEx 为三类用户提供集成服务：FedEx 寄件人、经认证的软件解决方案（即 FedEx 电商兼容供应商）以及经验证的 FedEx 集成供应商。
FedEx 寄件人：
通过 FedEx 寄件并需要将 FedEx API 集成到自身应用程序的公司。
解决方案或服务供应商：
需集成 FedEx API 以开发解决方案、应用程序或插件的公司（这些解决方案、应用程序或插件可向通过 FedEx 寄件的外部组织销售和/或分销）。
- FedEx 兼容供应商：通过 FedEx Compatible 计划认证且签订合同协议的公司。
- FedEx 集成供应商：通过 FedEx 集成商计划验证且签订合同协议的公司。
请选择最符合您业务类型的选项。无论您属于哪类用户，均可获取相应的入门指南。
选择以开始。
Which of the following best describes your business?
Select user
- FedEx Shipper: Company who integrates FedEx APIs into their own applications.
- FedEx Compatible Provider: Company validated 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.
- FedEx Integrator Provider: Validated company with a contractual agreement through the FedEx Integrator Program.
先决条件
您必须拥有 FedEx 用户 ID，才能登录 FedEx Developer Portal 并创建组织。
如果您的公司没有组织，请创建一个组织。如有，则请加入一个现有组织。
创建新组织
在导航栏中，点击“创建或加入组织”。
注意：作为创建者，系统会自动将您指定为组织管理员。
管理员可以：
邀请用户加入
为用户分配角色（例如贡献者、查看者）和项目
管理托运账户
有关这些角色的更多信息，请参阅我们的组织管理指南。
对于公司类型，请选择”出售或提供的软件解决方案使用 FedEx 技术，这是经过验证的 FedEx 集成供应商“。
提供您的公司名称、网站 URL 以及唯一的组织名称。组织名称可与您的公司名称一致，也可代表特定群组（部门、分公司、地区、地点）。 必须提供这些信息，才能验证您的请求。
注意：选择一个方便所有其他用户辨识的组织名称（例如公司名称、部门、地区、地点）。
请注明您的公司地点以及您的软件解决方案的销售或分销地点。
添加账单账户并进行账户身份验证
注意：作为 FedEx 集成商计划中的托运和物流供应商，您必须使用您自己的账号。您不能使用客户的 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 中包含以下内容，将会被拦截：
- RFC1918 IP 空格
- fedex.com 或其任何子域
- URL 中的 IP 地址（包括 localhost、127.0.0.1）
生成安全令牌
此安全令牌可以用作秘密密钥，用于实行身份验证和验证您的组织与 FedEx 之间的传输信息。您的安全令牌必须包含：
- 长度最少为 26 个字符，最多为 100 个字符
- 包含 1 个大写字母
- 包含 1 个小写字母
- 1 个数字字符
示例：Y1F6OiVUQW2JPSElmRE9U0IY5
定义 URL 和安全令牌后，可以开始创建 webhook 项目了。前往我的项目页面，打开 webhook 选项卡。单击创建 webhook 项目按钮。
选择订阅类型
FedEx 寄件人可为账号或查询号码订阅事件通知。
第 1 步：确认您的账单账号并选择功能
- 查看列出的默认账单账号进行确认，或从您的组织中选择其他账号。
- 选择功能（例如递送证明选项、预计送达时间选项、查询事件和事件型筛选条件）以配置您的项目。
第 2 步：输入项目详细信息
- 为您的项目指定一个组织范围内唯一的可识别名称。
- 输入您在预设置身份验证期间创建的目标 URL 和安全令牌详细信息（请参阅上面的步骤）。
- 要接收有关最新 webhook 更新和任何中断相关信息的通知，请输入电子邮件地址和首选语言。
第 3 步：阅读并接受条款
接受条款（包括 FedEx Developer Portal 许可协议和订单表）并单击“创建”按钮后，系统会显示确认页面。
根据您选择的订阅类型，可能还有其他步骤。请参见说明文件了解详情。
打开 API 项目概述页面，从测试密钥选项卡中检索您的测试凭据（API 密钥、秘密密钥和托运账号）。
第 1 步：请求 OAuth 访问令牌
每个 API 交易都必须使用 OAuth 访问令牌。令牌的有效期只有 1 小时，因此您需要在应用程序中编写相应代码，以便在会话过期前刷新令牌。请参阅 API Authorization 说明文件了解更多详情。
第 2 步：查看 API 说明文件
单击每个 API 的说明文件，以阅读业务背景并了解如何使用 API。登录后，通过说明文件页面顶部的按钮下载 JSON API 集合。您还可查看与您所需集成匹配的端点示例请求。
第 3 步：使用沙盒测试示例交易
单击左侧导航中的所需端点即可转到该特定沙盒。确定与您的用例相匹配的示例请求，然后使用您的测试凭证和 FedEx 测试 URL 来实现对端点的调用，如示例请求中所述。验证您所收到的 API 调用响应是否与说明文件中所示的一致。请参阅沙盒虚拟化指南，详细了解我们的测试经验。
使用 webhook 测试
测试步骤有助于您深入了解创建的 URL 是否有效。通过测试，FedEx 可以识别您的 URL 并与您的 URL 建立连接以发送数据。测试步骤还能为您提供样本测试数据，帮助您检查并确认您能否处理您的应用程序所提供的追踪数据。但是，测试步骤不会对您的 URL 进行身份验证。访问我们的 webhook 说明文件，了解如何测试您的 webhook URL。
前往项目概述页面，打开生产密钥选项卡。 Advanced Integrated Visibility 账号订阅项目不需要迁移至生产环境。
第 1 步：配置项目
- 视需要重命名您的密钥。
- 查看您在项目创建流程的步骤 1 中选择的账号。此账号用于将项目迁移到生产环境。项目投入生产后，您可按需添加更多账号。
第 2 步：获取项目密钥
复制所显示的生产 API 密钥和生产秘密密钥，并保存至安全的位置。为了保护您的生产秘密密钥，我们只会显示一次。如果您丢失该密钥，可以生成一个新的。
获取项目密钥并单击下一步之后，生产密钥选项卡上将显示您的项目详细信息。
- 若要向您的项目添加更多托运账号，请单击托运账号表顶部的编辑。
验证步骤因地区而异
下列步骤仅适用于美国和加拿大境内的客户。如果您的住址不位于上述两个国家境内，请访问 API 验证页面并寻求支持。
某些 API 需要托运标签验证，才能应用于我们的生产环境。请查看您的 API 是否需要验证。
第1步：在您启用Web的应用程序中开发并测试FedEx API
完成启用Web的应用程序的开发后，便可使用测试凭据（测试托运帐户、API密钥和秘密密钥）完成测试。“项目概述”页面上将显示您的测试API密钥和秘密密钥，您可随时查看。
第2步：将项目迁移到生产环境
完成 FedEx API 的测试后，您需要在 FedEx Developer Portal 上将您的项目迁移到生产环境，以开始验证流程。验证成功后，您就会看到生产 API 密钥和秘密密钥。生产秘密密钥只会出现一次，但您可在日后重新生成它。
第3步：填写标签封面表
完整填写标签封面表，包含适当的联系信息以及您计划实施的服务。还包括您的账号和生产密钥。
第 4 步：生成并向条码分析组提交测试标签
在与应用程序关联的 FedEx 测试环境中生成测试标签，然后将测试标签提交给 FedEx 标签评估团队以进行批准。条码分析组完成标签评估需要三个工作日。
请按照以下最佳实践操作，避免处理延迟：
- 打印和扫描的标签分辨率不得小于 600 DPI。请勿发送API生成的文件。
- 对于热敏打印机，所要求的标签图像类型必须与打印机型号相符。例如：Zebra 打印机要求 ZPLII 图像类型。
- 创建供评估的示例标签时使用寄件人/收件人地址信息。只为适用的特定服务创建示例标签。
- FedEx® 货到付款 (C.O.D.) 标签还必须包含对应的 C.O.D.退件标签。
- FedEx International Express® 货件还必须包含辅助/次要空运提单 (AWB) 标签。
- 一票多件货件(MPS)必须包含其中每件包裹的标签。
- 将 PDF 和标签封面表通过电子邮件发送到 label@fedex.com。
- 实物标签可邮寄到以下地址：
FedEx 服务
WTC-Business Solutions Testing
10 FedEx Parkway
2nd Floor Horizontal
Collierville, TN 38017
如果扫描的标签没有可见的缺陷（例如贯穿条码的线条、墨点或实际损坏），即可通过检查并将予以批准。
如要邮寄实物标签，请注意打印质量及避免无意间放大/缩小标签（即缩放）。以上是标签未通过标签评估流程的两大主要原因。
第 5 步：查看标签评估
条码分析组将评估所提交的测试标签并予以批准或拒绝。条码分析组将联系您说明所提交的标签是批准了还是被拒绝了。如果条码已批准，请继续下一步。如果条码被拒绝，请按照指示更正标签，然后重新提交以供批准。
第 6 步：启用应用程序
一旦测试标签获得条码分析组的批准，允许转为生产状态，即会授予您生产凭据，以用于发送经识别的托运标签交易，并通过电子邮件通知您验证成功。您的批准按项目进行。
第7步：替换URL和凭据
用生产URL和生产凭据替换测试URL和测试凭据。 在生产环境中使用示例数据重新测试您的实施。
先决条件
您的企业必须是现有的 FedEx 兼容供应商。如果您的企业未参加 FedEx Compatible 计划，则将以上选择改为“非兼容供应商”。
第 1 步：接收加入组织的邀请
FedEx 将会创建组织，然后邀请一名团队成员加入该组织。此用户将被指定为您组织的管理员。
第 2 步：接受邀请
如需接受邀请，您需要使用现有的用户 ID 和密码登录；或者，如果您的现有用户 ID 已经与其他组织关联，则需要创建新的用户 ID。
第 3 步：邀请用户
管理员可以邀请用户加入其组织，并为其分配角色和项目。打开“用户”选项卡。单击“添加用户”按钮。
- 选择用户角色：查看者、贡献者或管理员。请参阅我们的组织管理指南，了解有关角色的更多信息。
- 如果您目前有项目，请将项目分配给用户。您还可以在任何“项目概述”页面下，将用户分配至项目。
- 输入您希望以所选角色加入您组织的用户的电子邮件地址。
访问 API 目录，确定您解决方案的适用 API 或 webhook。您的 FedEx 客户技术顾问 (CTC) 和兼容渠道经理可协助您根据您的业务需求选择解决方案的适用 API。
第 1 步：填写 PIW
返回兼容供应商社区 (CPC)，填写产品信息工作表 (PIW)。
第 2 步：查看 FedEx 创建的项目
PIW 一经批准，FedEx 便会创建您的项目。每个解决方案的每一版本都在 FedEx Developer Portal 上有一个单独的项目。
第 3 步：与您的团队一起参加 API 演示
FedEx Compatible 团队和 FedEx CTC 以及验证团队还将为您的团队组织 API 技术演示。FedEx 团队将讨论“Compatible 计划认证”、新的 API 特色及功能，并且会解答相关问题。
打开 API 项目概述页面，从测试密钥选项卡中检索您的测试凭据（API 密钥和秘密密钥）。
第 1 步：创建客户密钥
使用凭据注册 API 创建客户密钥。这是私人 API，只能在您的 API 项目概述页面底部的 API 部分找到。
第 2 步：请求 OAuth 访问令牌
每个 API 交易都必须使用 OAuth 访问令牌。令牌的有效期只有 1 小时，因此您需要在应用程序中编写相应代码，以便在会话过期前刷新令牌。请参阅 API Authorization 说明文件了解更多详情。当查看示例代码时，请务必在示例下拉列表中选择“经销商”。
第 3 步：查看 API 说明文件
单击每个 API 的说明文件，以阅读业务背景并了解如何使用 API。登录后，通过说明文件页面顶部的按钮下载 JSON API 集合。您还可查看与您所需集成匹配的端点示例请求。
第 4 步：使用沙盒测试示例交易
单击左侧导航中的所需端点即可转到该特定沙盒。确定与您的用例相匹配的示例请求，然后使用您的测试凭证和 FedEx 测试 URL 来实现对端点的调用，如示例请求中所述。验证您所收到的 API 调用响应是否与说明文件中所示的一致。请参阅沙盒虚拟化指南，详细了解我们的测试经验。
第 5 步：验证每个解决方案
测试完解决方案后，将测试案例提交至验证团队，以验证每个解决方案。FedEx 将全面复查每个提交内容，您将在验证获批后收到更新信息。
使用 webhook 测试
如果您的组织能够访问 webhook，测试步骤有助于您深入了解创建的 URL 是否有效。通过测试，FedEx 可以识别您的 URL 并与您的 URL 建立连接以发送数据。测试步骤还能为您提供样本测试数据，帮助您检查并确认您能否处理您的应用程序所提供的追踪数据。但是，测试步骤不会对您的 URL 进行身份验证。访问我们的 webhook 说明文件，了解如何测试您的 webhook URL。
然后，FedEx 会将项目迁移到生产环境。前往 API 项目概述页面，打开生产密钥选项卡。单击秘密密钥列下的生成秘密密钥链接。
现在，您便可以在生产环境中使用示例数据重新测试您的实施。
先决条件
您必须拥有 FedEx 用户 ID 和账号，才能登录 FedEx Developer Portal 并创建组织。
如果您的公司还没有组织，请创建一个组织或加入公司的现有组织。
创建新组织
在导航栏中，点击“创建或加入组织”。
注意：作为创建者，系统会自动将您指定为组织管理员。
管理员可以：
邀请用户加入
为用户分配角色（例如贡献者、查看者）和项目
管理托运账户
有关这些角色的更多信息，请参阅我们的组织管理指南。
对于公司类型，请选择”出售或提供的软件解决方案使用 FedEx 技术，这是经过验证的 FedEx 集成供应商。“
提供您的公司名称、网站 URL 以及唯一的组织名称。组织名称可与您的公司名称一致，也可代表特定群组（部门、分公司、地区、地点）。 必须提供这些信息，才能验证您的请求。
注意：选择一个方便所有其他用户辨识的组织名称（例如公司名称、部门、地区、地点）。
请注明您的公司地点以及您的软件解决方案的销售或分销地点。
添加账单账户并进行账户身份验证
注意：作为 FedEx 集成商计划中的托运和物流供应商，您必须使用您自己的账号。您不能使用客户的 FedEx 账户。
请输入您的 FedEx 账号。 如果您目前没有 FedEx 账户，请在 fedex.com 开设一个账户或联系 FedEx 支持代表。
输入账户别名以及与该账户关联的账单邮寄地址。选择“下一步”。
注意：账单邮寄地址必须与我们记录中的此账户信息一致。这将成为您组织的默认账单账户。
要完成您的组织创建，您必须对账户进行身份验证。选择一个身份验证选项（电话-仅适用于美国和加拿大的集成商；电子邮件；短信），然后选择“下一步”。
收到验证码后，输入验证码并选择“提交”。
接受条款
请阅读《FedEx 集成商协议》和《计划手册》。选择复选框以确认您接受条款，然后选择“接受”。
屏幕将出现确认信息。点击“管理组织”，根据需要编辑详细信息。
邀请用户
注意：只有管理员才能邀请用户。
从左侧导航中选择“管理组织”。
转到“用户”选项卡并选择“添加用户”。
填写表格，并为新用户分配相应角色：查看者、贡献者或管理员。
有关用户角色的更多信息，请参阅组织管理指南。
在“项目”下拉菜单中，将用户分配到项目中（如适用）。
输入每个用户的电子邮件地址，然后选择“邀请”。
加入现有组织
请求邀请：请让您组织的管理员向您发送邀请。 接受邀请的有效期为 24 小时。如果需要，请让管理员重新发送。
接受邀请：使用您现有的用户 ID 和密码进行登录。 如果您的 ID 已经与其他组织关联，您必须创建一个新的 ID。
创建 API 项目
前往我的项目页面，然后选择创建项目。
填写项目名称字段。建议名称格式为“Projectname_applicationname”。完成后，选择下一步。
为您的项目选择 API 和 Advanced Integrated Visibility 产品。
注意：Advanced Integrated Visibility 产品仅适用于美国 FedEx 集成供应商。
注意：如果您选择任何付费产品，系统会要求您为该项目分配一个账单账户并接受必要条款。
分配账单并接受条款
通过已添加至组织的账户列表，分配一个账单账户。如果您之前选择了付费产品，才需要执行此步骤。
接受与该产品相关的条款和条件。
确认详情
查看所选产品。核实所提供的账单账户。
查看并接受 FedEx Developer Portal 许可协议。
点击创建，可生成您的项目并查看测试凭据。
在项目中配置 Advanced Integrated Visibility
先决条件
先决条件
- 审核定价：根据查询号码计数，订阅用户需要支付月度费用。请参阅订购单，详细了解定价。
- 设置账号：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 令牌，该令牌会在一小时后过期。
- 您的应用程序必须在令牌过期之前刷新令牌。
- 有关详细信息，请参阅 API Authorization 文档。
在沙盒中测试 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)
- 三种标签格式的寄件交易：PDF、PNG 和 ZPL (JSON)（适用于相关的托运 API 和费率 API）
避免延误的最佳实践
- 打印和扫描的标签分辨率不得小于 600 DPI。
- 热敏打印机标签必须与打印机型号匹配（例如 ZPLII 对应 Zebra 打印机）。
- FedEx International Express® 货件需要包含辅助空运提单 (AWB) 标签。
- 一票多件货件 (MPS) 必须包含每件包裹的标签。
标签评估
验证团队将批准或拒绝您提交的内容。
- 如果被拒，请根据反馈意见进行修改并重新提交
- 如果获批，您将收到一封确认验证成功的电子邮件。当您收到电子邮件后，您的生产凭据就会获得用于托运标签交易的授权。
按照验证后说明操作
根据需要查看并执行任何验证后要求。
收到生产密钥获批的通知后，请通过“项目概览”选项卡检索您的生产密钥。
- 复制并安全存储您的生产 API 密钥和秘密密钥。
- 秘密秘钥仅显示一次；如果丢失，您必须重新生成一个新的秘密秘钥。
