创建目录UI
创建目录UI有三种方式:
使用自有界面
在您自己的界面创建目录时,可使用:
- 自有数据存储和任意身份认证方案。使用此种方式请在您自己一侧实现目录UI。
- 您自己的授权和列示所有计划服务器方法。获取计划列表后请在您自己一侧实现目录UI。
- 艾克索拉登录管理器和客户端侧API调用。
艾克索拉登录管理器和客户端侧API调用
要实现目录:- 使用客户端方法获取订阅计划列表:
- 如项目配置了基于订阅的产品,请使用按产品获取订阅计划的客户端侧方法
- 如项目未配置基于订阅的产品,请使用获取订阅计划列表的客户端侧方法
- 实现在界面中显示收到的计划列表。
按产品获取订阅计划的客户端侧方法
在应用程序的的客户端侧,请使用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编码令牌。要获取该令牌:
- 如应用程序使用用户名和密码认证,请使用
Register new user 和Auth by username and password API调用。 如应用程序使用通过社交网络认证,请使用
Auth via social network API调用。
projectId
— 项目ID。可在发布商帐户项目名称旁边找到该参数。
productID
— 基于订阅的产品ID。要获取该值,请联系您的客户成功经理或发送邮件至csm@xsolla.com。
参数 | 类型 | 描述 |
---|---|---|
plan_id | array of integers | 计划ID。 |
| array of strings | 计划的外部ID。可在发布商帐户中的商品目录 > 订阅 > 订阅计划 > 您的计划部分找到或通过列示所有计划API调用找到。 |
| integer | 页面上元素数量的限制。默认显示15项。 |
| integer | 元素编号,从该元素开始生成列表。默认从0开始数。 |
| string | 用两个小写字母表示的界面语言。接受ISO 639-1值。如未传入此参数,则语言由用户IP地址决定。 可用值:
|
| string | 用于识别用户国家/地区的ISO 3166-1 alpha-2两字母代码。此参数影响区域位置和货币的选择。如未传入此参数,则国家/地区由用户的IP地址决定。 |
- curl
1curl -X 'GET' \
2'https://subscriptions.xsolla.com/api/user/v1/projects/{project_id}/products/{productId}/plans?country=RU ' \
3 -H 'accept: application/json' \
4 -H 'Authorization: Bearer client_user_jwt'
- javascript
1{
2 "items": [
3 {
4 "plan_id": 54321,
5 "plan_external_id": "PlanExternalId",
6 "plan_group_id": "TestGroupId",
7 "plan_type": "all",
8 "plan_name": "Localized plan name",
9 "plan_description": "Localized plan description",
10 "plan_start_date": "2021-04-11T13:51:02+03:00",
11 "plan_end_date": "2031-04-11T13:51:02+03:00",
12 "trial_period": 7,
13 "period": {
14 "value": 1,
15 "unit": "month"
16 },
17 "charge": {
18 "amount": 4.99,
19 "setup_fee": 0.99,
20 "currency": "USD"
21 },
22 "promotion": {
23 "promotion_charge_amount": 3.99,
24 "promotion_remaining_charges": 3
25 }
26 }
27 ],
28 "has_more": false
29}
获取订阅计划列表的客户端侧方法
在应用程序的的客户端侧,请使用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编码令牌。要获取该令牌:
- 如应用程序使用用户名和密码认证,请使用
Register new user 和Auth by username and password API调用。 如应用程序使用通过社交网络认证,请使用
Auth via social network API调用。
projectId
路径参数。可在发布商帐户项目名称旁边找到该参数。以请求参数的形式指定:
参数 | 类型 | 描述 |
---|---|---|
plan_id | array of integers | 计划ID。 |
| array of strings | 计划的外部ID。可在发布商帐户中的商品目录 > 订阅 > 订阅计划 > 您的计划部分找到或通过列示所有计划API调用找到。 |
| integer | 页面上元素数量的限制。默认显示15项。 |
| integer | 元素编号,从该元素开始生成列表。默认从0开始数。 |
| string | 用两个小写字母表示的界面语言。接受ISO 639-1值。如未传入此参数,则语言由用户IP地址决定。 可用值:
|
| string | 用于识别用户国家/地区的ISO 3166-1 alpha-2两字母代码。此参数影响区域位置和货币的选择。如未传入此参数,则国家/地区由用户的IP地址决定。 |
- curl
1curl -X 'GET' \
2'https://subscriptions.xsolla.com/api/user/v1/projects/{project_id}/plans?country=RU ' \
3 -H 'accept: application/json' \
4 -H 'Authorization: Bearer client_user_jwt'
- javascript
1{
2 "items": [
3 {
4 "plan_id": 54321,
5 "plan_external_id": "PlanExternalId",
6 "plan_group_id": "TestGroupId",
7 "plan_type": "all",
8 "plan_name": "Localized plan name",
9 "plan_description": "Localized plan description",
10 "plan_start_date": "2021-04-11T13:51:02+03:00",
11 "plan_end_date": "2031-04-11T13:51:02+03:00",
12 "trial_period": 7,
13 "period": {
14 "value": 1,
15 "unit": "month"
16 },
17 "charge": {
18 "amount": 4.99,
19 "setup_fee": 0.99,
20 "currency": "USD"
21 },
22 "promotion": {
23 "promotion_charge_amount": 3.99,
24 "promotion_remaining_charges": 3
25 }
26 }
27 ],
28 "has_more": false
29}
使用艾克索拉支付中心
- 实现通过服务器侧创建令牌API调用获取令牌。在请求中传入以下参数:
- 通过以下方式之一实现支付UI的打开:
- javascript
1{
2 "user": {
3 "name": {
4 "value": "j.smith@email.com"
5 },
6 "id": {
7 "value": "123a345b678c091d"
8 }
9 },
10 "settings": {
11 "project_id": 177226
12 }
13}
在艾克索拉支付中心里显示订阅目录的示例:
使用艾克索拉建站器
通过艾克索拉建站器您可以创建并设置自己的网站来销售订阅。方法是使用Web商店模板来创建网站。关于设置角色的详细信息,请参阅在有用户认证功能的网页商城中销售说明。

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