Shopify的API弃用:2022-01版

Shopify的API弃用:2022-01版

欢迎来到Shopify API弃用的另一个版本,在这里我们深入了解所有受支持版本即将生效的突破性更改。在本版本中,我们将回顾2021-04 API版本(截至2022年1月1日支持的最老版本)中的重大更改。这包括私人应用开发者的重要信息。让我们来看一看。

快速回顾一下版本控制

在我们深入研究您所面临的变化之前,让我们回顾一下如何Shopify的API版本控制的工作原理。

  • 我们每季度发布一个版本。这些发布通常发生在1月1日、4月1日、7月1日和10月1日左右。版本以年-月的格式命名(例如2022-01),确保它总是很容易识别版本变得稳定的时间,以及比较多个版本的时间线。
  • 应用程序通过在请求URL中指定API的特定版本来发出请求。当Shopify API不断发展时,应用程序可以构建在一个稳定的版本上,以确保API契约保持不变。请记住,这意味着在您的目标版本之后发布的任何功能都将无法访问,直到您更新请求URL。
  • 我们不断向商家发布新功能。为了在不影响最新稳定api的情况下发布特性,我们使用了候选版本。候选发行版只是下一个API版本,并且可以针对使用相同的年-月格式的请求。在候选版本中,您将找到刚刚发布的最新特性集。然而,由于它是不断发展的,你应该避免在应用的日常使用API时使用候选版本。为了获得稳定性和最新功能的好处,我们建议将应用程序的日常请求保持在稳定版本上,只将处理新发布功能的特定调用移动到候选版本。
  • 不要求特定版本的应用程序将提供最旧的支持版本。这允许现有的应用程序在我们发布版本控制时继续运行,而不必更新到新的url。这个概念也适用于显式调用不再支持的版本的应用程序。虽然每个应用程序都将受益于这种机制,防止在版本切换后出现所有请求错误,但我们建议有意针对最新版本。
  • 版本支持一年。取消对版本的支持使我们能够保持敏捷,并做出必要的更改,以便长期为我们的商家和Shopify平台提供最好的服务。虽然新版本的支持期为一年,但这意味着应用程序实际上只有9个月的时间来适应这些新变化,并在旧的行为不再可用之前利用新功能。

有了这个复习,让我们来回顾一下2022年1月1日你需要准备的关键信息。

1月1日会发生什么

2022年1月1日,以下变化将对我们的公共和私有应用程序的api生效:

  • 2022-01版本将变得稳定并准备好普遍使用。
  • 2021-01版本将不受支持。
  • 由于2021-04的变化而被弃用的请求将导致您的应用被标记。为了最大限度地减少对商家的影响,Shopify将把标记的应用程序从该应用程序列表中删除Shopify应用商店并阻止新的安装。此外,我们可能会通知商家,您的应用程序不再支持。

不久之后,我们自行决定:

  • 没有指定API版本的请求将被服务于2021 - 04版
  • 2021-01版本的请求将不再收到该版本。相反,这些请求将转到2021 - 04
  • 设置为2021-01的webhook将以同样的方式向前移动。

最重要的是,2021-04 API版本将成为默认版本,包括破坏性API更改。如果你的应用程序发出的请求将在2021-01年中断,你需要采取行动,在2022年1月1日之前迁移这些请求。如果不这样做,将导致请求失败和应用程序崩溃。

即将到来的重大变化

以下是2021-04年引入的突破性变化,2021-04将于2022年1月1日成为Shopify支持的最老版本。

支付应用程序的下一步行动

从API版本2021-04开始,使用redirectUrl字段PaymentSession必须更新自己的应用程序才能使用nextAction字段。

以前,处理支付的支付应用程序需要使用redirectUrl字段,以便在客户完成异地支付后重定向客户。这redirectUrlField只针对场外付款。

为了支持非异地支付方式,以及根据支付类型可能需要发生的其他操作,我们添加了以下字段PaymentSessionNextAction

  • 行动:支付应用必须执行的动作。重定向指示在客户完成付款后需要重定向客户指定完成支付过程不需要下一步操作。
  • 上下文:执行操作所需的任何数据。目前,上下文只能是PaymentSessionActionsRedirect

准备好迎接2022年1月1日吧

以下资源可以帮助您掌握Shopify平台的变化:

  • API运行状况报告中的每个应用运行状况报告合作伙伴仪表板它展示了会对您产生影响的API更改。
  • 电子邮件确保你的开发者联系邮箱是最新的,这样我们就可以通知你即将发生的变化。
  • 弃用标头:在你的应用中,X-Shopify-API-Deprecated-Reason头被添加到已弃用且将在9个月内不支持的请求中。
  • 开发人员的变更:随时了解Shopify api和其他开发者产品的最新变化
  • 弃用的API调用端点私有应用程序可以通过此端点访问其API运行状况信息。

请查看2022-01版本说明对于全套新功能,您的合作伙伴仪表板以了解哪些变化可能会影响您,或订阅我们每月的Shopify开发者和合作伙伴最新消息。

模板图标
主题:

借助Shopify合作伙伴计划发展您的业务

了解更多