USPS 和网络工具 API

USPS® and Web Tools APIs make it easy for developers to integrate USPS tools and resources into their own websites and applications. Learn more about what’s available and how you can access it.

New USPS APIs Developer Portal

Enhance your customer experience with leading-edge API management through the USPS APIs Developer Portal. We make it easy for you to integrate APIs into your website with self-service developer onboarding and a library of ready to use APIs.

When you sign up, you gain access to:

  • Testing environments
  • Interactive documentation
  • Modernized RESTful, HTTP-based APIs

Sign Up for USPS APIs

The deadline for migrating to the new USPS Label APIs was 2024 年 07 月 14 日. If you're still using Web Tools Label APIs, you risk service interruptions. Please contact your USPS Territory Representative to start the migration process.

Legacy Web Tools API Library

The USPS Web Tools® API Library will be phased out soon. Until then, Web Tools still gives access to important tools you may need for your ecommerce website. You can check shipping rates, track packages, and schedule a package pickup through the legacy program. Below you can find details on how to use the existing legacy Web Tools content.

Unsure whether you need to register for Web Tools API library or the new USPS APIs Developer Portal?

Web Tools Documentation & Updates

公告

网站工具2024 发行说明 (PDF)

Web Tools Label API Migration Guide (PDF)

Web Tools Label API Mapping Guide (XLSX)

网络工具声明:Account Duration (PDF)

网络工具声明:TLS 1.2 协议合规性(PDF)

更新的文档现在可用 (更新 9/20/2024)。

ExpressMail 到 ExpressMailCommitment API 过渡指南 - HTM | PDF

新标签 API 限制:

获取电子邮件更新

接收有关网络工具维护更新的电子邮件通知。

立即订阅

Legacy Web Tools Developer Center

第 1 步:注册

填写在线注册表格以进行访问。请注意,注册是访问网络工具所必需的,并且与任何其他 USPS.com 凭据是分开的。

立即注册

Once registered, you’ll receive an email with your assigned Web Tools User ID. You’ll then have access to our most popular APIs like the price calculator and address validation/standardization. 为了访问更安全的 API,例如标签打印,您需要在“步骤”中请求额外的权限 3。

第 2 步:查看文件

浏览 API 技术文档,并使用下面提供的快速代码在您喜欢的浏览器中进行测试。

对于将网络工具集成到自定义应用程序中的开发人员,我们特别建议:

第 3 步:集成并请求额外的权限

与 USPS WEB TOOLS 集成,开始对网络工具 API 进行实时调用,并使您和您客户的运送更加轻松。

要访问更安全的 API,例如标签打印,您将需要额外的权限。联系互联网客户服务中心并提供以下信息:

  • 电子邮件的主题行中写明“ 网络工具 API 访问”
  • 除了那些已自动提供的之外,您还想访问哪些 API
  • 如果要修改标签图像

需要更多帮助?查看常见问题

展开全部

查看 API 技术文件

从价格计算器入门

首先尝试国内或国际邮资费率 API,或者直接跳入技术文件并开始开发。

直接从浏览器的搜索栏中浏览网络工具

完成注册后,浏览最受欢迎的网络工具 API,并直接从您的浏览器中实时调用网络工具。进行实时通话:

  1. 打开一个新的 .txt 或者 word.doc,然后从您在 registration@shippingapis.com 中收到的电子邮件中复制并粘贴用户 ID。将信息备好,以在下列步骤中使用。
  2. 将您的网络工具用户 ID 插入 USERID =“”值
  3. 将今天的日期插入“ ShipDate”标签的值(如有)
  4. 选择下面的整个 XML 代码,然后将其粘贴到浏览器的搜索栏中
  5. 按“Enter”进行呼叫,并在浏览器中收到回复
  6. 试用网络工具,并更改 XML 标签的某些值

尝试国内费率计算器

轻松快捷地在线计算国内及国际邮寄邮资费率。尝试下面的“国内费率 API”,或跳入技术文件并开始开发。

查看技术文件

测试 XML 请求

https://secure.shippingapis.com/shippingapi.dll?API=RateV4&XML=<RateV4Request USERID="XXXXXXXXXXXX">

<Revision>2</Revision>
<Package ID="1ST">
<Service>优先</Service>
<ZipOrigination>33420</ZipOrigination>
<ZipDestination>54174</ZipDestination>
<Pounds>0</Pounds>
<Ounces>2</Ounces>
<Container></Container>
<Width></Width>
<Length></Length>
<Height></Height>
<Girth></Girth>
<Machinable>错误</Machinable>
</Package>
</RateV4Request>

尝试国际价格计算器

“国际费率 API”可轻松快捷地计算国际邮资。在下面尝试一下,或跳入技术文件并开始开发。

查看技术文件

测试 XML 请求

https://secure.shippingapis.com/shippingapi.dll?API=IntlRateV2&XML=<IntlRateV2Request USERID="XXXXXXXXXXXX">

<Revision>2</Revision>
<Package ID="1ST">
<Pounds>2</Pounds>
<Ounces>0</Ounces>
<Machinable>正确</Machinable>
<MailType>包裹</MailType>
<ValueOfContents>20</ValueOfContents>
<Country>危地马拉</Country>
<Container></Container>
<Size></Size>
<Width></Width>
<Length></Length>
<Height></Height>
<Girth></Girth>
<OriginZip>18701</OriginZip>
<CommercialFlag>N</CommercialFlag>
<DestinationPostalCode></DestinationPostalCode>
</Package>
</IntlRateV2Request>

核实地址

通过减少因地址输入错误导致的邮寄错误,从而节省时间和金钱。该工具可用于纠正街道地址错误,包括缩写和遗失信息。同时它还支持 ZIP+4® 编码。

查看技术文件

测试 XML 请求

地址验证

https://secure.shippingapis.com/ShippingAPI.dll?API=Verify&XML=<AddressValidateRequest USERID="XXXXXXXXXXXX">

<Address>
<Address1></Address1>
<Address2>6406 IVY LANE</Address2>
<City>GREENBELT</City>
<State>MD</State>
<Zip5>20770</Zip5>
<Zip4></Zip4>
</Address>
</AddressValidateRequest>

ZIP Code 查找

https://secure.shippingapis.com/ShippingAPI.dll?API=ZipCodeLookup&XML=<ZipCodeLookupRequest USERID="XXXXXXXXXXXX">

<Address>
<Address1></Address1>
<Address2>6406 IVY LANE</Address2>
<City>GREENBELT</City>
<State>MD</State>
</Address>
</ZipCodeLookupRequest>

城市/州查找

https://secure.shippingapis.com/ShippingAPI.dll?API=CityStateLookup&XML=<CityStateLookupRequest USERID="XXXXXXXXXXXX">

<ZipCode ID="0">
<Zip5>90210</Zip5>
</ZipCode>
</CityStateLookupRequest>

追踪包裹

Get estimated delivery information and track any package shipped via Priority Mail Express® or Priority Mail Express International® services. 使用 USPS Tracking®、Signature Confirmation、Certified Mail®、或 Registered Mail® 服务,查询已邮寄包裹的追踪状态。

查看技术文件

测试 XML 请求

https://secure.shippingapis.com/shippingapi.dll?API=TrackV2&XML=<TrackRequest USERID="XXXXXXXXXXXX">

<TrackID ID="XXXXXXXXXXXXXX"/>
</TrackRequest>

查找投递日期

利用服务标准与承诺 API,获取预计的及保证的投递日期。

测试 XML 请求

Priority Mail® 服务标准

https://secure.shippingapis.com/ShippingAPI.dll?API=PriorityMail&XML=<PriorityMailRequest USERID="XXXXXXXXXXXX">

<OriginZip>21403</OriginZip>
<DestinationZip>90210</DestinationZip>
</PriorityMailRequest>

查看技术文件

First-Class Mail® 服务标准

https://secure.shippingapis.com/ShippingAPI.dll?API=FirstClassMail&XML=<FirstClassMailRequest USERID="XXXXXXXXXXXX">

<OriginZip>90210</OriginZip>
<DestinationZip>26505</DestinationZip>
</FirstClassMailRequest>

查看技术文件

Priority Mail Express® 服务承诺

https://secure.shippingapis.com/ShippingAPI.dll?API=ExpressmailCommitment&XML=<ExpressMailCommitmentRequest USERID="XXXXXXXXXXXX">

<OriginZIP>20862</OriginZIP>
<DestinationZIP>11210</DestinationZIP>
<Date></Date>
</ExpressMailCommitmentRequest>

查看技术文件

服务投递计算器

https://secure.shippingapis.com/ShippingAPI.dll?API=SDCGetLocations&XML=<SDCGetLocationsRequest USERID="XXXXXXXXXXXX">

<MailClass>0</MailClass>
<OriginZip>70601</OriginZip>
<DestinationZip>21817</DestinationZip>
<AcceptDate>2019 年 8 月 6 日</AcceptDate>
<AcceptTime>0900</AcceptTime>
<NonEMDetail>正确</NonEMDetail>
</SDCGetLocationsRequest>

查看技术文件

展开全部或关闭所有内容主题,以立即跟随标题

开发人员:网络工具 FAQs (常见问题回答)

打开或关闭下面的内容 USPS API是免费的吗?

注册了 USPS WEB TOOLS® 帐户并同意使用条款和条件的客户,可以免费访问 USPS API。

打开或关闭下面的内容 如何获得对 USPS API 的访问权并收到我的用户 ID?

注册网络工具用户帐户时,获取 USPS API 的访问。

立即注册

注册后,您将自动收到一封电子邮件,其中包含您分配的网络工具用户 ID。收到此电子邮件后,您可以使用以下 API:

  • 价格计算器
  • 服务标准及承诺
  • 地址信息
  • 包裹领取

打开或关闭下面的内容 我可以打印的标签包含“ SAMPLE-DO NOT MAIL”水印。如何打印实际的标签?

包含“ Certify”的 API 是我们的测试 API,它将打印带有示例水印的标签。为了生成实际标签,必须从所有网络工具 XML 请求中删除“Certify”。

打开或关闭下面的内容 USPS 是否有可用的 EDDM API?

我们目前仅通过我们的在线应用程序,提供“EVERY DOOR DIRECT MAIL®”®(EDDM®) 服务。

前往 EDDM

打开或关闭下面的内容 网络工具 API 近期或即将发生更改吗?

为了提供最好的 API 产品,我们会定期更新我们的系统,这可能需要当前的客户更新他们的软件。要确定这些更改/更新是否适用于您,请参阅我们最新的发布说明。本文件包含所有新的更改和解决您受到影响的步骤。如有任何与集成有关的问题,请记住首先与您的软件提供商联系。

寄件人支持中心

USPS WEB TOOLS® 是可用于在线商店或客户服务中心的电子商务应用程序接口 (API)——并可免费使用。

电子商务网站支持

通过我们的简单注册步骤即可轻松访问网络工具 API。查看常见问题

立即注册

注册后,您将收到一封电子邮件,其中包含您分配的网络工具用户 ID。然后,您便可以访问最受欢迎的 API。要访问更安全的 API,例如标签打印,您将需要额外的权限。联系互联网客户服务中心并提供以下信息:

  • 电子邮件的主题行中写明“ 网络工具 API 访问”
  • 您使用的软件供应商
  • 除了那些已自动提供的之外,您还想访问哪些 API

想雇佣一名专业人士?

为了协助需要帮助将 USPS WEB TOOLS 集成到其站点中的公司,The Postal Service (邮政局) 发布一些愿意提供符合我们标准的服务的公司的联系信息。这些列表并非详尽无遗,列出的列表并未经 USPS 担保。

USPS WEB TOOLS® 集成器

一些公司可以帮助您集成 USPS WEB TOOLS,或帮助您使用网络工具电子商务 API 制定客户解决方案。
View List of Integrators (PDF)

USPS 网站工具产品供应商

这些使用网络工具销售产品的公司已经集成。
View List of Product Providers (PDF)

展开全部或关闭所有内容主题,以立即跟随标题

寄件人:网络工具 FAQs (常见问题回答)

打开或关闭下面的内容 当我尝试登录到 USPS.com 时,为什么我的网络工具凭据不起作用?

USPS.com® 上的登录页面与 API 不相关。网络工具凭据没有“登录”功能。您的用户名和密码将使您能够访问网络工具服务器。

使用您的凭据可以:

  • 登录到第三方软件的界面
  • 在 API,XML 中向您的后端编程添加身份验证

usps.com 网站上显示的登录页面并未与 API 关联。如果您需要有关集成的更多信息,请查阅技术文件。

打开或关闭下面的内容 为什么当我单击收到的生产服务器 URL 时它们不起作用?

包含在电子邮件中,用于确认您已通过网络工具注册的生产 URL,并没有链接到可见的网站。这些 URL 必须被包括在连接到我们的 API 的 XML 请求中(请参阅我们的技术文件),以获得更多信息。如果您使用的是第三方电子商务软件,则可能不要求这些 URL,因此,不要应用于所有使用我们 API 的客户。请与您的软件提供商联系,以获取有关集成要求的更多详细信息。

打开或关闭下面的内容 我正在使用第三方电子商务软件连接到 USPS 的 API,但在从 USPS 检索价格或服务时遇到问题。

由于 USPS® 不了解所有可用软件选项中的每个特定集成的要求,因此建议客户首先联系其提供商以解决集成方面的问题。

打开或关闭下面的内容 我已联系我的软件提供商,但是仍对 USPS 有疑问。我该如何进行?

联系互联网客户服务中心时,只要您提供以下信息,我们将竭诚为所有客户提供帮助。

客户必须提供:

  • 导致问题或错误的示例 XML 请求副本,粘贴到电子邮件正文中
  • 有关您遇到的确切问题的完整描述
  • API 名称
  • 第三方软件提供商名称

请注意,没有以上信息,我们的 USPS® 代理将没有足够的信息来正确调查网络工具 API 问题。

联系我们

如果您有技术问题或需要更多信息,请与互联网客户服务中心(ICCC)联系。

营业时间

周一至周五:美国东部时间上午 8 点 - 晚上 8:30 点
周六:美国东部时间上午 8 点 - 下午 6 点
休息时间:周日及邮递假日
假日营业时间:美国东部时间上午 9 点 - 下午 6 点

  • 马丁·路德·金诞辰纪念日
  • 总统纪念日
  • Columbus 日
  • 退伍老兵纪念日

联系信息

电子邮件互联网客户服务中心
致电:1-800-344-7779

Powered by Translations.com GlobalLink Web SoftwarePowered by GlobalLink Web