加入您公司的组织,与团队展开协作。若您的公司尚无组织,您可创建一个。
加入现有组织
1. 申请邀请
请联系您公司组织的管理员向您发送邀请。您需在 24 小时内接受该邀请。若邀请已过期,请联系管理员重新发送。
2. 接受邀请
使用您现有的用户 ID 和密码登录。若您的用户 ID 已关联至其他组织,请创建一个新 ID。
创建新组织
当您创建一个组织后,您将成为该组织的管理员。 作为管理员,您可以邀请用户加入组织、分配项目与用户角色,并管理托运账户。
如需进一步了解用户角色,请参阅组织管理指南。
1. 登录 FedEx Developer Portal。
2. 从菜单中,选择我的项目,然后选择创建组织。
3. 输入以下详细信息:
- 在我任职的公司选项中,选择使用 FedEx 进行托运,并需将 FedEx API 集成至其自有应用程序中
- 输入您公司的名称、公司网站,以及一个团队成员能够识别的组织名称(例如公司名称、部门、分支机构或区域名称)。
4. 选择创建。
您之后可在菜单中的管理组织下更新或补充详细信息。
添加托运账户
1. 在添加账户卡片上选择添加托运账户。若您尚无 FedEx 账户,请选择创建账户以开设新账户,或联系 FedEx 支持人员。
2. 选择 + 添加账户。
3. 输入您的 FedEx 账号、账户别名,以及您在开立账户时使用的账单邮寄地址。
4. 接受最终用户许可协议,或将其转发给您公司的授权代表进行处理。
添加账单账户
1. 选择账单账户选项卡。若您尚无 FedEx 账单账户,可选择开设账单账户 以开立新账户 或联系 FedEx 支持人员。
2. 选择添加账单账户。账单账户必须位于美国境内。
3. 输入您的 FedEx 账号、账号别名,以及您在开立账户时使用的美国账单邮寄地址。
4. 阅读并接受最终用户许可协议。
管理员如何邀请用户
1. 从菜单中,选择管理组织,然后选择用户选项卡。
2. 选择+ 添加用户。
3. 选择国家或地区和首选语言,然后选择用户角色:查看者、贡献者或管理员。
4. (可选)将用户分配至项目。您随时可以从项目的概览页面为用户分配项目。
5. 输入用户的电子邮件地址并点击邀请。您可一次性邀请最多 20 位用户,电子邮件地址之间请用逗号分隔。邀请将于 24 小时后过期。
创建 API 项目
1. 在菜单中,选择我的项目,然后选择 API 标签,并选择 + 创建 API 项目。
2. 确认您的 API 需求。
3. 选择要添加在项目中的 API。
4. 创建项目名称并选择您计划寄件的目的国家/地区,即可获取一个测试托运账户。对于欧洲境内的国内货件,您需要为每个国家/地区分别申请独立的测试账户。您之后可随时添加或移除国家/地区。
5. 在通知下选择设置,以设置您的通知偏好。
6. 阅读并接受条款和条件。
创建 Advanced Integrated Visibility 项目
1. 在您的应用程序或平台中创建一个用于接收回调的目标 URL。此 URL 必须:
- 使用 HTTPS
- 请勿使用 RFC1918 IP 地址段、fedex.com 及其子域名,以及 localhost 或 127.0.0.1 等 IP 地址
2. 生成用于身份验证的安全令牌。此令牌必须:
- 包含 26–100 个字符,且至少包含一个大写字母、一个小写字母和一个数字
3. 从菜单中选择我的项目,然后选择 Advanced Integrated Visibility 选项卡。
4. 选择创建 Advanced Integrated Visibility 项目。
5. 选择用户类型。
- FedEx 寄件人:使用 FedEx 进行托运,并需将 FedEx API 集成至其自有应用程序中
- FedEx 电商兼容供应商:即经 FedEx 认证的电商兼容供应商
- FedEx 集成服务提供商:销售或提供基于 FedEx 技术的软件解决方案,并已通过 FedEx 认证的集成服务提供商
6. 选择订阅类型。您可通过账号或追踪号码订阅事件通知。
7. 确认账单账户,并选择您所需的功能,例如递送证明、预计送达时间、查询事件或基于事件进行筛选。
8. 输入项目详细信息。
- 输入唯一且易于识别的项目名称。
- 输入您创建的目标 URL 和安全令牌。
- 输入用于接收 Advanced Integrated Visibility 更新及服务中断通知的电子邮件地址和首选语言。
9. 接受 FedEx Developer Portal 许可协议与订购单,并选择创建。
注意:根据您选择的订阅类型,可能还需完成其他步骤。详情请参见我们的 Webhook 文档。
请按照以下步骤验证您的 API 集成,并确认您的应用程序能够发送和接收测试数据。
获取测试凭证
1. 从菜单中选择我的项目,然后选择项目名称。
2. 在 API 密钥选项卡上的测试密钥下,找到您的测试凭据。
3. 登录后,点击文档页面顶部的下载 JSON 架构按钮,即可下载 JSON API 集合文件。查阅您集成所使用的端点的示例请求。
4. 申请 OAuth 访问令牌,用于每次 API 事务的身份验证。
注意:该令牌有效期为 1 小时,您可将应用程序配置为在令牌过期前自动刷新。详情请参阅 API Authorization 文档。
5. 从菜单中选择 API 目录,选择您需要使用的 API,然后选择文档。
6. 从菜单中,选择端点。
7. 使用您的测试凭证和 FedEx 测试 URL 发送示例请求,然后确认返回的响应与文档示例一致。详情请参阅沙盒虚拟化指南。
8. 运行 Advanced Integrated Visibility 测试,生成样本数据,并确认您的应用程序能正确处理查询信息。
注意:测试不会对您的回调 URL 进行身份验证。详情请参阅 Advanced Integrated Visibility 文档。
将项目迁移到生产环境
上线前完成生产环境配置。您可重命名密钥,在项目上线后添加更多账户,并复核项目创建时选定的账号。该账号将用于将您的项目迁移至生产环境。
注意:基于账号的 Advanced Integrated Visibility 项目无需进行生产环境激活。
1. 从菜单中选择我的项目,然后选择项目名称。
2. 选择生产密钥选项卡。
3. 获取您的生产环境凭证并妥善存储。
- 将生产环境 API 密钥和密钥复制并保存在安全位置。
- 生产密钥申请后仅显示一次,请务必将其保存在安全位置。若不慎遗失,之后可重新生成新密钥。
4. 选择下一步,在生产密钥选项卡中查看您的项目详情。
如需添加更多托运账户,请选择托运账户表顶部的编辑。
验证您的 API
部分 FedEx API 需先通过托运标签验证,方可在生产环境中使用。开始前,请查阅 API 验证要求。
1. 从菜单中选择我的项目,然后选择项目名称。
2. 在 API 密钥选项卡上的测试密钥下,找到您的测试凭据。
3. 测试完成后,请在 FedEx Developer Portal 中将项目迁移至生产环境以启动验证流程。
- 生产密钥申请后仅显示一次,请务必将其保存在安全位置。若不慎遗失,之后可重新生成新密钥。
4. 在标签封面表中填写所需信息,包括联系方式、计划使用的服务、账号及生产环境 API 密钥。
5. 在 FedEx 测试环境中创建测试标签,然后提交至 FedEx 条码分析小组进行审核。标签评估需 3 个工作日,请耐心等待。
避免延误的最佳实践:
- 标签的打印与扫描分辨率不得低于 600 DPI。请勿提交由 API 直接生成的文件。
- 若使用热敏打印机,请申请与您的打印机匹配的图像格式,例如 Zebra 打印机请使用 ZPLII 格式。
- 制作示例标签时,请使用有效的寄件人与收件人地址。仅为您计划使用的服务创建标签。
- 使用 FedEx 货到付款 (C.O.D.) 服务时,请一并提供 C.O.D. 退件标签。
- 使用 FedEx International Express® 服务时,请一并提供辅助(第二)空运提单 (AWB)。
- 对于一票多件货件 (MPS),请为每一件包裹分别提交一个标签。
通过以下任一方式提交您的材料:
- 将 PDF 和标签封面表通过电子邮件发送到 label@fedex.com。
- 实体标签请邮寄至:
FedEx Services
WTC-Business Solutions Testing
10 FedEx Parkway
2nd Floor Horizontal
Collierville, TN 38017
注意:实体标签须确保无明显缺陷,如墨迹线条或破损。打印时请勿放大或缩小标签。
6. FedEx 条码分析小组将对您提交的材料进行审核,并根据审核结果批准或拒绝标签。若标签未通过审核,请根据反馈意见进行修改后重新提交。
7. 审核通过后,FedEx 条码分析小组将向您发送电子邮件通知,确认您的生产环境凭证已获授权用于托运标签相关事务。
注意:审核通过结果仅对当前项目有效。每个新项目均需单独通过审核。
8. 将测试 URL 及凭证替换为生产环境 URL 及凭证。
9. 使用样本数据进行最后一次生产环境测试,以确认一切运行正常。
