en zh

开始使用 Samsung IAP API

有两种 Samsung 应用程序内购买 (IAP) API,提供以下功能:

  • Orders - 查看特定日期的付款和退款
  • Publish - 查看、注册、修改和删除 IAP 项目
  • Subscription - Cancel, refund, revoke or check the status of IAP subscription items

要开始使用 IAP API,必须满足特定的要求并使用下述规定的授权头参数。

要求

要使用 IAP APIs,需要满足以下条件:

  • IAP APIs 属于 Galaxy Store 开发者 API 的一部分。您必须满足 Galaxy Store 开发者 API 的所有要求,包括但不限于创建访问令牌、在每个 IAP 发布 API 调用的授权标头中包括访问令牌,以及取得商业卖家身份,以便管理应用程序内购买项目。

  • IAP APIs 必须与卖家门户的“应用程序内购买”选项卡区域中的内容之间建立连接。要创建此连接,您必须先使用内容发布 API分发内容,或者内容必须在卖家门户中处于 For Sale 状态。如果此连接不存在,则无法检索匹配的产品信息。

  • 您必须将 IAP SDK 集成到您的应用程序中。在您的内容中注册的所有二进制文件必须支持 IAP。

如果不满足这些要求,将返回错误代码 106。

授权标头参数

每个请求都必须包括授权标头参数,用于指定内容类型、您的访问令牌和服务帐户 ID。有关如何创建访问令牌和服务帐户 ID 的详细信息,请参阅创建访问令牌

属性

说明

Authorization

必需。使用 Bearer <your-access-token>,其中 <your-access-token> 是您从 Galaxy Store 身份验证服务器请求的访问令牌

service-account-id

必需。服务帐户 ID,用于创建与访问令牌关联的 JWT(可以在卖家门户的“帮助”>“API 服务”区域中找到)

content-type

必需。必需为 application/json

以下示例显示了与 IAP APIs 结合使用的标头:

curl -X <IAP_PUBLISH-or-ORDER_API_REQUEST-or-IAP_SUBSCRIPTION> \
  -H  "content-type: application/json" \
  -H  "Authorization: Bearer <your-access-token>" \
  -H  "service-account-id: <your-service-account-id>"

URL 路径参数

The URL path for every IAP Publish and Subscription API request must contain the package name (for the IAP Orders API, the package name may be required in the body parameter). For the IAP Subscription API, the in-app item purchase transaction identifier is also required.

属性

说明

packageName

Required for IAP Order and Subscription APIs.。应用程序的程序包名称

purchaseId

Required for IAP Subscription API。Unique identifier of the in-app item purchase transaction

The following example shows the URL path for creating an item using the IAP Publish API:

https://devapi.samsungapps.com/iap/v6/applications/<packageName>/items

The following example shows the URL path for canceling, refunding, or revoking a subscription using the IAP Subscription API:

https://devapi.samsungapps.com/iap/seller/v6/applications/<packageName>/items/purchases/subscriptions/<purchaseId>