创建目录UI

创建目录UI有三种方式:

使用自有界面

在您自己的界面创建目录时,可使用:

注:
您也可以使用SDK库在自有界面中实现目录。现成的库提供可直接使用的数据结构和方法来与艾克索拉API交互,便于将艾克索拉产品集成到您的项目中。

艾克索拉登录管理器和客户端侧API调用

要实现目录:
  1. 使用客户端方法获取订阅计划列表:
  2. 实现在界面中显示收到的计划列表。

按产品获取订阅计划的客户端侧方法

在应用程序的的客户端侧,请使用HTTP get请求实现获取订阅计划列表:https://subscriptions.xsolla.com​/api/user/v1/projects/{project_id}/products/{​​productId}/plans

请求必须包含Authorization: Bearer <client_user_jwt>头,其中<client_user_jwt>是用户的JSON Web令牌(JWT),它是一个根据Base64标准编码的Base64编码令牌。要获取该令牌:

以路径参数的形式指定:
  • projectId — 项目ID。可在发布商帐户项目名称旁边找到该参数。
  • productID — 基于订阅的产品ID。要获取该值,请联系您的客户成功经理或发送邮件至csm@xsolla.com

以请求参数的形式指定:
参数类型描述
plan_id
array of integers计划ID。
plan_external_id
array of strings计划的外部ID。可在发布商帐户中的订阅 > 订阅计划 > 您的计划部分找到或通过列示所有计划API调用找到。
limit
integer页面上元素数量的限制。默认显示15项。
offset
integer元素编号,从该元素开始生成列表。默认从0开始数。
locale
string用两个小写字母表示的界面语言。接受ISO 639-1值。如未传入此参数,则语言由用户IP地址决定。
可用值:
  • en — 英语
  • ar — 阿拉伯语
  • bg — 保加利亚语
  • cn — 中文(简体)
  • cs — 捷克语
  • de — 德语
  • es — 西班牙语
  • fr — 法语
  • he — 希伯来语
  • it — 意大利语
  • ja — 日语
  • ko — 韩语
  • pl — 波兰语
  • pt — 葡萄牙语
  • ro — 罗马尼亚语
  • ru — 俄语
  • th — 泰语
  • tr — 土耳其语
  • tw — 中文(繁体)
  • vi — 越南语
如传入的区域位置不在艾克索拉列表中,将使用英语。
country
string用于识别用户国家/地区的ISO 3166-1 alpha-2两字母代码。此参数影响区域位置和货币的选择。如未传入此参数,则国家/地区由用户的IP地址决定。
Copy
Full screen
Small screen
    curl -X 'GET' \
    'https://subscriptions.xsolla.com​/api/user/v1/projects/{project_id}/products/{​​productId}/plans?country=RU  ' \
      -H 'accept: application/json' \
      -H 'Authorization: Bearer client_user_jwt'
    
    Copy
    Full screen
    Small screen
    {
      "items": [
        {
          "plan_id": 54321,
          "plan_external_id": "PlanExternalId",
          "plan_group_id": "TestGroupId",
          "plan_type": "all",
          "plan_name": "Localized plan name",
          "plan_description": "Localized plan description",
          "plan_start_date": "2021-04-11T13:51:02+03:00",
          "plan_end_date": "2031-04-11T13:51:02+03:00",
          "trial_period": 7,
          "period": {
            "value": 1,
            "unit": "month"
          },
          "charge": {
            "amount": 4.99,
            "setup_fee": 0.99,
            "currency": "USD"
          },
          "promotion": {
            "promotion_charge_amount": 3.99,
            "promotion_remaining_charges": 3
          }
        }
      ],
      "has_more": false
    }
    

    获取订阅计划列表的客户端侧方法

    在应用程序的的客户端侧,请使用HTTP GET请求实现获取订阅计划列表:https://subscriptions.xsolla.com​/api/user/v1/projects/{project_id}/plans

    请求必须包含Authorization: Bearer <client_user_jwt>头,其中<client_user_jwt>是用户的JSON Web令牌(JWT),它是一个根据Base64标准编码的Base64编码令牌。要获取该令牌:

    指定项目ID作为projectId路径参数。可在发布商帐户项目名称旁边找到该参数。

    以请求参数的形式指定:

    参数类型描述
    plan_id
    array of integers计划ID。
    plan_external_id
    array of strings计划的外部ID。可在发布商帐户中的订阅 > 订阅计划 > 您的计划部分找到或通过列示所有计划API调用找到。
    limit
    integer页面上元素数量的限制。默认显示15项。
    offset
    integer元素编号,从该元素开始生成列表。默认从0开始数。
    locale
    string用两个小写字母表示的界面语言。接受ISO 639-1值。如未传入此参数,则语言由用户IP地址决定。
    可用值:
    • en — 英语
    • ar — 阿拉伯语
    • bg — 保加利亚语
    • cn — 中文(简体)
    • cs — 捷克语
    • de — 德语
    • es — 西班牙语
    • fr — 法语
    • he — 希伯来语
    • it — 意大利语
    • ja — 日语
    • ko — 韩语
    • pl — 波兰语
    • pt — 葡萄牙语
    • ro — 罗马尼亚语
    • ru — 俄语
    • th — 泰语
    • tr — 土耳其语
    • tw — 中文(繁体)
    • vi — 越南语
    如传入的区域位置不在艾克索拉列表中,将使用英语。
    country
    string用于识别用户国家/地区的ISO 3166-1 alpha-2两字母代码。此参数影响区域位置和货币的选择。如未传入此参数,则国家/地区由用户的IP地址决定。
    Copy
    Full screen
    Small screen
      curl -X 'GET' \
      'https://subscriptions.xsolla.com​/api/user/v1/projects/{project_id}/plans?country=RU  ' \
        -H 'accept: application/json' \
        -H 'Authorization: Bearer client_user_jwt'
        
      
      Copy
      Full screen
      Small screen
      {
        "items": [
          {
            "plan_id": 54321,
            "plan_external_id": "PlanExternalId",
            "plan_group_id": "TestGroupId",
            "plan_type": "all",
            "plan_name": "Localized plan name",
            "plan_description": "Localized plan description",
            "plan_start_date": "2021-04-11T13:51:02+03:00",
            "plan_end_date": "2031-04-11T13:51:02+03:00",
            "trial_period": 7,
            "period": {
              "value": 1,
              "unit": "month"
            },
            "charge": {
              "amount": 4.99,
              "setup_fee": 0.99,
              "currency": "USD"
            },
            "promotion": {
              "promotion_charge_amount": 3.99,
              "promotion_remaining_charges": 3
            }
          }
        ],
        "has_more": false
      }
      

      使用艾克索拉支付中心

      1. 实现通过服务器侧创建令牌API调用获取令牌。在请求中传入以下参数:
        • user.id — 授权系统中的用户ID。
        • user.email — 用户邮箱。必须符合RFC 822协议的标准。
        • settings.project_id — 项目ID。可在发布商帐户中项目名称旁边找到此参数。
      2. 通过以下方式之一实现支付UI的打开:
      Copy
      Full screen
      Small screen
      {
          "user": {
              "name": {
                  "value": "j.smith@email.com"
              },
              "id": {
                  "value": "123a345b678c091d"
              }
          },
          "settings": {
              "project_id": 177226
          }
      }
      

      在艾克索拉支付中心里显示订阅目录的示例:

      使用艾克索拉建站器

      通过艾克索拉建站器您可以创建并设置自己的网站来销售订阅。方法是使用Web商店模板来创建网站。关于设置角色的详细信息,请参阅在有用户认证功能的网页商城中销售说明。

      您的进度
      感谢您的反馈!
      上次更新时间: 2024年1月22日

      发现了错别字或其他内容错误? 请选择文本,然后按Ctrl+Enter。

      报告问题
      我们非常重视内容质量。您的反馈将帮助我们做得更好。
      请留下邮箱以便我们后续跟进
      感谢您的反馈!