开始
与 FedEx 完成集成后，即可开始利用 FedEx API 和 webhook 提供的价值。以下说明将指导您完成相应流程，包括设置组织、创建项目或以兼容用户身份开始集成。
第1步：
浏览 API 和 webhook
您可以首先浏览我们的 API 和 webhook，明确您的需求并为您的应用程序确定最佳解决方案。
- 转到 API 目录，开始浏览。
- 选择一个 API 或 webhook，可阅读概览、了解更改日志和查看主要功能。
- 查看文档，详细了解请求和响应元素、所选编程语言的示例、错误代码等多项内容。
- 查看公告页面，了解已计划的服务更新并获取最新信息。
第2步：
注册或登录
使用您的 fedex.com 用户 ID 和密码登录，开始与 FedEx API 和 webhook 进行集成。
如果您还没有用户 ID，可免费注册一个。
第3步：
创建或加入组织。
如果您的公司还没有组织，请创建一个组织或加入公司的现有组织。
创建组织的步骤如下：
如果您是组织的创建者，系统会将您自动列为该组织的管理员。
- 管理员可以邀请用户加入其组织、为其分配角色（例如：贡献者或查看者）和项目，还可管理托运账号。
- 要详细了解分配角色，请参阅我们的组织管理指南。
要创建自己的组织，可单击左侧导航中的创建组织。
提供组织信息
- 提供您的公司名称和网站 URL，并创建组织名称。为您的组织提供一个方便其他用户辨识的名称。该名称可用于将您的公司划分成更多特定群组（例如：部门、分公司、地区、地点），也可与您的公司同名。
加入组织的步骤如下：
完成下列步骤，可加入现有组织：
- 请求您组织的管理员向您发送邀请
- 如果您的公司已创建了组织，请让组织的管理员邀请您加入。接受邀请的有效期为24小时。如果超出时限，可随时请求管理员再次发送邀请。
- 接受邀请
- 如需接受邀请，您需要使用现有的用户 ID 和密码登录；或者，如果您的现有用户 ID 已经与其他组织关联，则需要创建新的用户 ID。
第4步：
添加托运帐户。
- 填写帐户信息
- 输入您的账号、账号别名以及与此账号关联的账单邮寄地址。然后，我们将验证账单邮寄地址，确保其与账号详细信息一致，以免存在欺诈活动。
- 如需查看与您的用户 ID 关联的托运账号，请转到管理组织页面和托运账号选项卡。要创建新的托运账号，请与您的 FedEx 销售代表联系。
- 最终用户许可协议
- 然后，您必须接受最终用户许可协议 (EULA)，或将协议发送给最终用户公司内可接受该协议的其他人员。您可以在“管理组织”页面的托运账号选项卡下查看 EULA 的状态。
第5步：
将用户添加至您的组织
管理员可以邀请用户加入其组织，并为其分配角色和项目。首先，要在“管理组织”页面中添加用户，可完成下列步骤（带有“*”标记的为可选步骤）：
输入用户电子邮件地址
- 输入需要邀请加入组织的任何用户电子邮件地址。要输入多个电子邮件地址，可在各个地址之间使用空格、逗号、分号或 Enter 键
选择用户角色
- 如果查看者的默认选项不符合该用户的需求，请选择其他用户角色。*
为项目分配用户
- 如果您已创建了项目，则可将用户分配给项目。*
管理员始终有权访问所有项目，但必须将贡献者或查看者分配至相应项目（除非贡献者是项目的创建者，在此情况下，这些角色将自动分配至该项目）。
无论用户是否接受邀请，您都可以直接在管理组织页面的用户选项卡中快速更新用户的项目或角色。
- 单击角色或项目旁边的插入符号，就会显示一个含多个选项的下拉列表
- 选择其中一个选项，然后单击应用按钮，保存您的选择。
第1步：
创建项目以获取凭据。
您组织的管理员或贡献者可以单击创建 API 项目按钮，从而创建 API 项目。
开始之前，您首先要告诉我们您为何需要访问 FedEx API。页面将出现一个模式并显示下拉列表选项。您应该选择最适合自身业务需求的选项，以便与 FedEx API 集成。
如果您属于寄件人，则可开始创建项目。此过程分为三个步骤：
- 选择API
选择您希望添加在项目中的 API。根据所选 API，您可能需要选择更多选项。
如果选择追踪 API，您还需要：
- 选择一个账号，与您的生产密钥关联。
- 查看追踪 API 配额、速率限制和 API 认证详情。
- 选择是否需要在超出交易配额的情况下使用电子邮件通知。
- 配置项目
输入项目详细信息（包括名称和托运地点）。
- 为您的项目指定一个组织范围内唯一的可识别名称
- 选择您要在其境内托运的任何国家/地区，以便我们可为您分配测试托运账号。要测试欧洲国家/地区内的国内托运包裹，每个国家/地区都必须有独立的测试账号。稍后您可以随时添加/移除国家/地区。
- 要获得有关最新 API 更新和任何中断相关信息的通知，您可以设置通知首选项。
- 确认详情
查看您的项目详情，然后接受条款和条件。
- 请阅读并接受 FedEx Developer Portal 许可协议，并确认您无意出售或分发您的应用程序。
- 单击“创建”按钮后，将出现确认页面。然后，您可在新项目中查看您的测试凭据。
第2步：
集成 API 并测试您的实施
账号）。接着，您可以
- 请求必须用于每个 API 交易的 OAuth 访问令牌。令牌的有效期只有 1 小时，因此您需要在应用程序中编写相应代码，以便在会话过期前刷新令牌。有关更多详情，请参阅 API 授权文档
- 单击 API 的任何文档，阅读每个 API 的业务背景，从而充分了解如何使用相应 API。您还可查看与您所需集成匹配的端点请求示例。
- 按照请求示例中的说明执行对这些端点的调用，使用您的测试凭据对端点进行配置。
- 验证您所收到的 API 调用响应是否与文档中所示的一致。
- 使用您的测试凭据和 FedEx 测试 URL，在 FedEx 测试环境中测试您的实施。
第3步：
将项目迁移到生产环境
可完成下列步骤。
在配置项目步骤内：
- 您可按需对新密钥进行重命名。
- 查看您在项目创建流程的步骤 1 中选择的账号。此账号用于将项目迁移到生产环境。项目投入生产后，您可按需添加更多账号。
在获取项目密钥步骤内：
- 我们将显示您的生产 API 密钥和生产秘密密钥。请务必将它们复制到安全的位置。
- 为了保护您的生产秘密密钥，我们只会显示一次。如果您丢失该密钥，可以生成一个新的。
- 单击下一步。
您将立即跳转回项目概览页面。您可在此添加与您的项目关联的更多账号。
在项目概览页面上：
- 单击 3 个竖点（或三点菜单），添加与您的项目关联的更多账号。
- 接着，单击编辑。
您将前往 API 密钥页面，您可在此页面添加需要与此项目生产密钥关联的任何其他账号。
第4步：
完成您的认证
- 某些 API 需要托运标签认证，才能应用于我们的生产环境。为了满足此要求，您需要完成项目中所有 API 的认证流程。
在所有 API 都完成认证并启用后，请用生产 URL、密钥和托运账号替换测试 URL、密钥和托运账号，以更新您的 API 请求。
在生产环境中使用示例数据重新测试您的实施。
享受您新集成的便利！
创建 webhook 项目的前提条件
创建 webhook 项目
创建 webhook 项目的前提条件
第1步：
在目的地应用程序/平台中创建有效的 URL
在您的目的地应用程序/平台中创建有效的 URL，接收来自 FedEx 的身份验证码/身份验证消息和 Tracking webhook 负载通知。
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 进行身份验证。
访问我们的 webhook 文档，了解如何测试您的 webhook URL。
第4步：
验证目的地 URL
使用 HMAC SHA256 散列算法，建立身份验证流程，从而验证您的目的地 URL 与 FedEx 之间的传输信息。
- 当您单击创建时，FedEx 会生成一个随机的质询字符串，并通过请求正文将字符串发送给您。相应地，您需要在响应正文中将此质询字符串返回给 FedEx。
- 采用 HMAC SHA256 算法/程序，对消息验证码 (MAC) 进行初始化，进而对质询字符串和安全令牌（或秘密密钥）进行散列（或组合）以形成散列签名
- 在响应正文中，将 challengeString 和 challengeStringResponse 连同 HTTP 状态码 200 (OK) 或 202 (ACCEPTED) 一起返回给 FedEx。
- FedEx 将立即验证质询字符串和质询字符串响应。
- FedEx 收到响应正文后，就会将 challengeString 和 challengeStringResponse（或之前生成的散列签名）分别与 FedEx 所生成的 challengeString 和散列签名进行比对，从而验证所收到的 challengeString 和 challengeStringResponse。
- 如果“challengeString”和 HMAC 签名都匹配，则说明验证和工作流程均已操作成功。否则，就会验证失败，并显示相应的错误消息。
创建 webhook 项目
第1步：
创建 webhook 项目，可接收已配置的负载通知
打开我的项目页面，转到 Webhooks 选项卡。
您组织的管理员或贡献者可以单击创建 Webhook 项目按钮，从而创建 webhook 项目。
开始之前，您首先要告诉我们您为何需要访问 FedEx webhook。页面将出现一个模式并显示下拉列表选项。您应该选择最适合自身业务需求的选项，以便与 FedEx webhook 集成。
如果您属于寄件人，则可完成下列步骤，开始创建项目：
- 识别您的业务需求
- 选择最符合您的业务与 FedEx webhook 集成需求的选项。
- 选择层级和层级功能
- 根据您的项目需求，针对您的项目选择基本或高级的 webhook 层级。
- 稍后您可以随时编辑层级选择。
- 每一层级均需收取每月订阅费。
- 选择要在项目中配置的功能。
- 您也可以稍后编辑这些功能。
- 配置项目详情
- 为您的项目指定一个可识别名称
- 提供预生成的目的地 URL 和安全令牌详情，这些信息是在预设置身份验证期间创建的。
| 字段名称 | 说明 |
|---|---|
Webhook 项目名称 目的地 URL |
这是非空且唯一的 webhook 项目名称，不得在任何其他 webhook 项目中重复出现该名称。
您可通过此 URL 接收追踪事件数据/负载。
|
安全令牌 |
此令牌可用作共享秘密密钥，以实行身份验证并验证 Tracking webhook 响应。
|
负载语言（国家/地区） 追踪类型 |
从下拉列表中选择追踪数据翻译的首选语言。 选择需要接收追踪数据的响应类型
|
电子邮件地址 |
提供电子邮件地址，以便在更改您的 webhook 项目（例如：已创建、已编辑、已取消）时接收电子邮件通知。 |
电子邮件语言（国家/地区） |
选择您希望从 FedEx 接收 webhook 电子邮件通知的首选语言 以下是受支持的电子邮件通知语言：
|
- 选择账号
- 从符合条件（基于美国或加拿大）的账号列表中选择您希望与项目关联的账号。
5. 确认详情并接受条款
- 查看已配置项目详情。
- 请阅读并接受 Developer Portal 许可协议，并确认您无意分发您的应用程序。
- 请阅读并接受定价协议。
- 单击创建项目按钮后：
- 如果您的创建请求已被成功验证和处理，您将跳转至确认页面。
- 如果验证不成功或失败，则将出现一条错误消息。
- 然后，您的 Tracking webhook 项目将出现由系统生成的 webhook ID，并显示为“活跃”状态。
第1步：
FedEx 可创建兼容供应商组织
- FedEx 将会创建组织，然后邀请一名团队成员加入该组织。此用户将被指定为您组织的管理员。
- 完成认证和集成后，您便能轻松将解决方案分发给客户。
第2步：
接受邀请。
- 若要访问API集成项目和文档，请接受邀请。要接受邀请，您需要使用FedEx用户ID和密码登录，或者，如果您没有相应凭证，则需要创建一个。
第3步：
邀请用户加入您的组织。
- 作为管理员，您可以邀请需要访问项目或组织的任何团队成员。有关不同角色的详细信息，请参见组织管理指南。
- 如果您的组织已创建，请让组织的管理员或FedEx来邀请您加入。您有24小时来接受邀请，如果超出此时间期限，可请求管理员再次发送邀请。
第4步：
选择您的解决方案所需的API。
访问 API 目录，可确定您的解决方案的适用 API。您的 FedEx 客户技术顾问 (CTC) 和兼容渠道经理可协助您根据您的业务需求选择解决方案的适用 API。
选择一个API以了解概述、更改日志和主要特点。
查看API文档以了解请求和响应元素、使用所选语言的示例、错误对象及其他。
返回Salesforce以填写产品信息工作表(PIW)，并列出您想添加到解决方案中的API。
第5步：
FedEx创建项目。
PIW一经批准，FedEx便会创建您的项目。每个解决方案的每一版本都在FedEx Developer Portal中有一个单独的项目。如果用户不是组织的管理员，则需要获得邀请才能查看每个项目。
此时FedEx兼容团队和FedEx CTC以及认证团队还将为您的团队组织API技术演示。FedEx团队将讨论您要采用API版本的新特点和可用功能。团队可以解答有关API的技术问题，进行API测试，以及处理开始API“认证*”流程前必须完成的所有流程。
* 认证 – FedEx兼容计划定义的用于满足计划合规要求的流程。必须完成兼容计划认证，才能确保所有兼容提供商按照FedEx技术和服务标准的定义，实施、营销以及向寄件人（客户）分发FedEx技术。
第6步：
将API集成到您的应用程序并进行兼容计划认证。
- 现在您可以访问“测试API密钥”和“测试秘密密钥”，以开始运行交易。从“项目概述”页面的“测试密钥”选项卡中检索这些密钥。
- 若要创建客户密钥，您需要使用凭证注册API，此私人API仅可在每个项目的API部分找到。
- 创建若干客户密钥后，请继续并请求要与每个API交易搭配使用的OAuth访问令牌。令牌会话的有效期只有1小时，因此您必须在应用程序中编写相应代码以在会话过期前刷新令牌。有关详细信息，请参阅API授权文档。当查看示例代码时，请务必在示例下拉列表中选择“经销商”。
- 选择“测试密钥”页面上的API文档，阅读业务背景以充分了解如何使用选定的API。查看与您所需集成匹配的端点请求示例。
- 按照请求示例中的说明执行对这些端点的调用，将其配置为使用您的测试凭据。
- 验证收到的API调用响应是否与文档中所示的一致。
- 使用测试凭据和FedEx测试URI，在FedEx测试环境中全面测试您的实施。
- 完全测试您的解决方案后，在Salesforce中认证每个解决方案。FedEx将全面复查每个提交内容，您将在认证批准后获得更新信息。
第7步：
FedEx将项目迁移到生产环境。
- 然后，FedEx会将项目迁移到生产环境。
- 您随后将能在“项目概览”页面的“生产密钥”选项卡下看到您的生产API密钥。
第8步：
生成生产秘密密钥。
- 您需要单击秘密密钥列下的生成秘密密钥链接，以生成“生产秘密密钥”。
- 现在，您便可以在生产环境中使用示例数据重新测试您的实施。
- 享受您新集成的便利！
