手册

介绍

左侧边栏包含指向相应部分的链接：

• 用户名 - 链接到个人资料。
• 仪表盘 - 以图表和图形的形式查看当前状态。
• 应用程序 - 应用管理。
• 解锁代码 - 自动生成或由您下载的解锁码。
• 付款 - 用户收款历史。
• 手册 - 当前的用户手册。

仪表盘

您可以为仪表板中的所有小部件设置通用过滤器：

• 货币 - 在仪表板上将收入和支出金额转换为的货币。
• 时期 - 在仪表板的图表和表格中显示数据的时间段。它确定了对支付、应用程序和其他参数的信息和统计信息进行分析和显示的时间间隔。

余额

余额包括以下金额：

• 总额 - 所选时期内所有用户付款的总金额，不包括支付系统和PayToUse的费用。
• 净额 - 所选时期内所有付款的总金额减去支付系统和PayToUse的费用。
• 待处理金额 - 指定时期内的所有付款总金额减去支付系统和PayToUse的费用，待提取到开发者账户。付款在支付后7天后可用于提取。
• 可用金额 - 所有时间内所有付款的总金额减去支付系统和PayToUse的费用，可用于提取到开发者账户。

付款

支付小部件包括按应用程序分组的所选时期内的付款表。

表字段：

• 应用程序 - 应用程序。仅显示在所选时期内进行了付款的应用程序。
• 付款 - 付款数量。
• 总额 - 所选时期内所有用户付款的总金额，不包括支付系统和PayToUse的费用。
• 净额 - 所选时期内所有付款的总金额减去支付系统和PayToUse的费用。

图表显示了每天净额和总额值的动态。

新用户

新用户图表显示了每天的两个动态值：

• 新用户 - 新API调用的数量。仅当发送到API的请求中传递了device参数（唯一设备标识符）时，才会记录API访问。此参数必须对设备真正唯一。 (查看发送请求)
• 付款 - 同一时期每天的付款数量。

转化

转化率指标是评估您的销售效率将新用户转化为付款的指标。

图表显示了付款与新用户的数量比例，以百分比表示。

应用程序

当您进入此部分时，将打开您的应用程序列表。

应用程序表中的列列表：

• # - 唯一应用标识符。在验证应用程序代码或显示付款表单时使用。
• 名称 - 应用程序名称。名称仅在报告和仪表板中向您显示。单击应用程序名称将打开应用程序编辑页面。
• 状态 - 应用程序的当前状态。可能是：
• 创建时间 - 应用程序刚刚创建，尚未配置。
• 已发布 - 应用程序正在运行。
• 创建时间 - 应用程序创建日期。
• 其他控制按钮：
• 删除 - 从列表中删除应用程序。

创建或编辑应用程序

为了接受付款，您必须连续填写所有必要的应用程序数据并激活应用程序。

创建新应用程序的按钮位于应用程序列表的标题栏中。

应用程序

创建应用程序时可用的字段：

• 名称 - 您在报告或仪表板上可以看到的应用程序名称。名称将显示在已保存应用程序的页面标题中。只要应用程序尚未保存，名称将显示为“New app”。必须输入该字段。
• 联系邮箱 - 将发送给用户的消息副本的电子邮件地址。此地址也指定在“回复”字段中，并用于用户回复带有代码的收到的电子邮件。必须输入该字段。默认情况下，该字段填充了来自开发者配置文件的值。该值可以更改为不同的值。
• 应用程序类型 - 应用程序类型。如果选择了组类型的应用程序，则会显示一个应用程序列表进行分组。列表中仅显示生成解锁代码的单个应用程序。
• 允许付款反馈 - 向付款表单添加一个字段，供用户输入自由文本。反馈将添加到开发人员的电子邮件副本中。还可以在付款详细信息中看到反馈。

开始输入更改值，保存按钮将出现。保存按钮允许您在不转到下一页的情况下保存更改。下一页按钮保存更改并移动到下一页。您始终可以返回以稍后进行更改。

在页面标题中，只有已保存的应用程序页面可用于导航。您可以单击“下一页”或转到页面标题中的部分。

描述

从列表中选择一种语言，然后单击“添加”。

将显示一个选定语言的本地化应用程序文本选项卡。

可用语言：

• 德语
• 英语
• 法语
• 西班牙语
• 俄语
• 简体中文

描述中的字段用于在付款表单上显示信息，并在向用户的回复消息中显示：

• 名称 - 选择的语言的应用程序名称。显示在付款表单上和付款通知电子邮件中。默认情况下，添加语言时会插入应用程序名称。您可以为每种语言设置不同的名称。必填字段。
• 描述 - 应用程序的简要描述。显示在应用程序名称下的付款表单上。可选字段。如果您不希望显示任何描述，可以将其留空。
• 回复 - 付款成功后将发送给用户的附加信息。响应文本将添加到标准响应之后的电子邮件末尾。

必须添加至少一种语言才能保存并转到下一页。

在付款表单中显示的语言是根据用户在浏览器设置中指定的偏好自动确定的。您可以为应用程序保存应用程序语言。

开始输入或更改值，然后会出现“保存”按钮。保存按钮允许您在不转到下一页的情况下保存更改。下一页按钮保存更改并转到下一页。您始终可以返回以稍后进行更改。

在页面标题中，只有已保存的应用程序页面可用于导航。您可以单击“下一页”或转到页面标题中的部分。

价格

该页面包含与付款相关的价格列表和字段：

• 试用期 - 试用期的长度。
• 时间单位 - 试用期的时间单位。例如，如果您指定为7天，则表示在应用程序的第一次 API 调用后的 7 天之后，它将返回试用期已过期的响应。保存了第一次设备调用的时间。
• 价格计算方法 - 价格计算方法从列表中选择：
• 根据期限计算价格 - 在付款表单中，用户指定代码的激活期限，价格根据下面的表格自动计算。用户将在响应电子邮件中收到自动生成的解锁代码。
• 根据价格计算期限 - 在付款表单中，用户从列表中选择一个价格或输入自己的价格值，期限根据下面的表格自动计算。用户将在响应消息中收到自动生成的代码。
• 永久代码 - 在付款表单中，用户从列表中选择一个价格或输入自己的价格值。付款后，他们将在响应电子邮件中收到与所选价格对应的代码。
• 捐赠 - 在付款表单中，用户从列表中选择一个价格或输入自己的价格值。对于捐款类型的应用程序，不生成解锁代码。

价格以美元为单位。最低价格为1美元。

开始输入或更改值，然后会出现“保存”按钮。保存按钮允许您在不转到下一页的情况下保存更改。下一页按钮保存更改并转到下一页。您始终可以返回以稍后进行更改。

在页面标题中，只有已保存的应用程序页面可用于导航。您可以单击“下一页”或转到页面标题中的部分。

预览

此页面设置以下值：

• 代码长度 - 生成的代码的长度（如果适用）。
• 代码字符集 - 生成代码的字符集：
• 数字代码 - 仅使用数字 0、1、2、3、4、5、6、7、8、9 生成代码。代码中可能包含前导零。验证代码时，前导零是重要的。
• 字母数字代码 - 使用字符 1、2、3、4、5、6、7、8、9、A、B、C、D、E、F、G、H、I、G、K、L、M、N、P、Q、R、S、T、U、V、X、Y、Z 生成代码。代码使用大写字符生成并发送给用户。验证代码时，字符的大小写不重要。
• 检查代码的链接 - 用于代码验证的示例链接。
• 支付链接 - 付款链接。您可以复制链接并将其粘贴到应用程序发布的网站上的描述中。 需要传递的参数：
• app - 应用程序的唯一标识符。必需参数。
• amount - 购买时在价格字段中指定的金额。默认价格将被忽略。但是，金额不能低于最低价格，也不能低于应用程序设置的最低价格。可选参数。

要开始接受付款，您需要使用“启动”按钮激活应用程序。在激活应用程序之前，请确保输入的所有数据都是正确的。应用程序生成的密钥无法更改。

代码验证

应用程序解锁代码的检查分为3个步骤：

1. 编写并发送用于代码验证的请求
2. API端的检查
3. 接收并处理 API 响应

发送请求

要验证代码，您的应用程序用户必须在应用程序设置中的字段中输入它。

<properties>
	<property id="UnlockCode" type="string"></property>
	<property id="UnlockResult" type="string">Checking...</property>
	...
<properties>

<settings>
	<setting propertyKey="@Properties.UnlockCode" title="@Strings.UnlockCode">
		<settingConfig type="alphaNumeric" maxLength="12"/>
	</setting>
	<setting propertyKey="@Properties.UnlockResult" title="@Strings.UnlockResult">
		<settingConfig type="alphaNumeric" readonly="true"/>
	</setting>
	...
</settings>

然后，您需要向付费使用 API 服务器发送请求：

function onTemporalEvent() as Void {
	var ds = System.getDeviceSettings();
	return Toybox.Communications.makeWebRequest(
		"https://api.pay-to-use.com", // API URL
		{
			"device" => ds.uniqueIdentifier, // 设备唯一标识符
			"app" => "6", // 您的应用程序 ID
			"model" => ds.partNumber, // device part number
			"code" => Application.Properties.getValue("UnlockCode") // 您的应用程序中的解锁代码值
		},
		{
			:method => Communications.HTTP_REQUEST_METHOD_POST,
			:headers => { "Content-Type" => Communications.REQUEST_CONTENT_TYPE_JSON },
			:responseType => Communications.HTTP_RESPONSE_CONTENT_TYPE_JSON
		},
		method(:onReceive)
	);
}

API 请求参数:

• url - https://api.pay-to-use.com. Using HTTPS is mandatory.
• 请求的正文（传递的值）。键值对字典：
• device - 设备的唯一标识符。
• app - 您的应用程序的唯一标识符。
• model - device model identifier. Optional parameter. Data is used to display statistics for new devices.
• code - 用户在您的应用程序设置中输入的解锁代码。
• 请求选项：
• :method - API 支持 GET 和 POST 请求方法。
• :headers - 对于 POST 方法，参数需要以 JSON 格式传递。
• :responseType - 响应以 JSON 格式返回。
• responseCallback - 链接到回调方法，该方法应该接受两个参数：
• responseCode - 服务器响应头代码。
• data - 如果请求成功，则为内容，否则为 null。

API端的检查

如果没有向 API 传递参数，则 API 返回 HTTP/1.1 404 Not Found 头。

如果至少向 API 传递了一个参数，则 API 返回头 HTTP/1.1 200 OK。

服务器响应包括：

• response - 响应代码
• msg - 响应的文本描述
• expires - UNIXTIME 时间戳（如果适用）

进行检查以确保传入的应用程序标识符是正确的。 支付时应用程序必须处于 已发布 状态。 如果出错，将返回响应代码 301。

如果传输了唯一设备标识符，则会搜索并存储该设备标识符。 如果在检查或保存时出现错误，则返回错误代码 402。 如果发现此类返回代码，请立即写信给支持团队，地址为 [email protected]

如果代码通过，那么对于 根据期限计算价格 和 根据价格计算期限 计算方法的应用程序，将执行以下步骤：

• 如果传输了空代码，则会从前面步骤中定义的唯一设备标识符中分离。
• 如果传输了非空代码并且未激活，则根据购买代码时指定的价格条件激活代码，而与激活日期无关。
• 如果未传输代码或传输的代码未找到，则返回错误代码 201。
• 已激活的代码与设备进行检查，如果在激活期间传输了与存储的唯一设备标识符不同的唯一设备标识符，则返回错误代码 202。
• 如果传输的代码没有到期日期并且所有先前的检查都已通过，则返回代码 101。
• 如果代码是有时间限制的，则执行检查。如果密钥未过期，则返回代码 101。如果代码已过期，则返回错误代码 203。
• 此类应用程序要求代码绑定到设备。如果未传输唯一设备标识符，则返回错误代码 304。

对于具有 永久代码 的应用程序，仅检查购买时代码的可用性。 如果找到代码，则返回代码 101。如果找不到代码，则返回错误代码 201。

对于具有 捐赠 计算方法的应用程序，不检查代码。 始终返回代码 101。

如果先前的检查未通过，则检查测试期。 如果自设备首次联系以来的时间已经过去比当前应用程序设置的时间长，则返回错误代码 204。 如果试用期尚未到期，则返回错误代码 102。

如果仅传输应用程序 ID，而没有传输解锁代码或唯一设备 ID，则返回错误代码 303。

如果返回的响应是 500，您应该写信至 [email protected] 请求支持

以下是所有返回的代码表：

{
	"response":101,
	"msg":"Active forever",
	"expires":0
}

{
	"response":101,
	"msg":"Active until 28 Dec 2024",
	"expires":1735369863
}

{
	"response":101,
	"msg":"The code check was successfull",
	"expires":0
}

{
	"response":101,
	"msg":"No code check required",
	"expires":0
}

{
	"response":102,
	"msg":"Trial period expires in 2d 8h 49m",
	"expires":1729440013
}

{
	"response":201,
	"msg":"Code not found"
}

{
	"response":202,
	"msg":"Used on the another device"
}

{
	"response":203,
	"msg":"Expiration: 2 Sep 2024",
	"expires":1725261063
}

{
	"response":204,
	"msg":"Trial period expired"
}

{
	"response":301,
	"msg":"Application not found"
}

{
	"response":302,
	"msg":"Term undefined"
}

{
	"response":303,
	"msg":"Not enought arguments"
}

{
	"response":304,
	"msg":"Device is nesessary"
}

{
	"response":401,
	"msg":"Error code saving"
}

{
	"response":402,
	"msg":"Error device saving"
}

{
	"response":500,
	"msg":"Unknown error"
}

检查响应

然后您应该检查 Pay-to-use API 服务器的响应：

function onReceive(responseHeader, data) as Void {
	if (responseHeader == 200) { Toybox.Background.exit(data); }
}

您可以检查所有标题和代码，您可以为用户方便显示自己的消息，但在最简单的形式中，验证将看起来像这样：

function onBackgroundData(data) as Void {
	if (data.hasKey("response")) {
		if (data.hasKey("msg")) {
			// 您可以在属性字段中使用名称“UnlockResult”显示data["msg"]。
			Application.Properties.setValue("UnlockResult", data["msg"]);
		}
		if (data["response"].toString().substring(0, 1).equals("2")) {
			// 代码验证失败
			// 付费功能不可用
			...
		} else {
			// 代码检查成功或错误是您的错误或 API 的错误
			// 付费功能可用
			...
		}
	}
}

解锁代码

当您进入此部分时，将打开一个解锁代码列表。

解锁代码列表

您可以在顶部搜索栏中搜索电子邮件字段或代码。找到的代码将显示在列表中。您可以使用电子邮件或代码的全部或部分作为搜索标准。匹配项将以颜色突出显示。搜索和过滤器同时工作，彼此不排斥。

用户的最后使用的过滤器会被保存。也就是说，下次进入页面时，最后使用的过滤器将自动应用。解锁代码列表提供以下过滤器：

• 列 - 选择在解锁代码列表中显示的表列。
• 应用程序 - 仅显示所选应用程序的解锁代码。
• 状态 - 仅显示处于所选状态的解锁代码。

解锁代码表中的列列表：

• 应用程序 - 您的应用程序。您可以按照链接编辑其设置。
• 代码 - 解锁代码。
• 电子邮件 - 与解锁代码注册相关联的电子邮件地址。该地址用于在网站的我的购买部分搜索客户的解锁代码。此部分对用户可见。
• 期限 - 发送的代码的有效期（在应用程序设置中指定）。代码设置了一个有效期，与创建时应用程序设置的条件相对应。
• 状态 - 解锁代码状态。 (查看解锁代码状态)
• 创建时间 - 解锁代码创建日期。
• 已激活 - 代码的激活日期。当特定用户设备首次联系PayToUse API服务并提交此代码时，将设置激活日期。代码的状态变为已激活。只有非活动代码才能被激活。如果由具有不同ID的设备提交了活动代码，则API将返回错误202。一个代码只能与一个设备关联。
• 到期时间 - 代码激活到期日期。对于在代码激活时具有有限有效期的代码进行设置。对于没有限制有效期的代码，到期日期保持为空白。
• 已删除 - 代码删除日期。删除后，代码状态设置为未知。
• 支付编号 - 支付的唯一序列号。您可以单击链接查看付款的详细信息。
• 解锁代码的操作按钮。例如，删除。

解锁代码状态

在其生命周期中，解锁代码经历了不同的状态，可以通过代码状态进行跟踪。

付款

当您进入此部分时，将打开用户付款列表。

以下支付系统用于接收付款：

支付系统费用之后，PayToUse将收取13%的费用。我们一直在努力降低费用。

如果支付系统出现任何争议或退款，支付系统的处罚将重新发给开发者。因此，您不应允许发生这种情况。在有争议的情况下，PayToUse不会收取费用。

付款列表

您可以在顶部搜索栏中搜索电子邮件字段或发送的代码。找到的付款将显示在列表中。您可以将电子邮件或发送的代码的全部或部分用作搜索标准。匹配项将以颜色高亮显示。搜索和过滤器同时工作，彼此不互斥。

最后使用的过滤器将保存给用户。也就是说，下次您进入页面时，将自动应用上次使用的过滤器。对付款列表可用的过滤器有：

• 列 - 选择要在付款列表中显示的表列。
• 应用程序 - 仅显示所选应用程序的付款。
• 系统 - 仅显示来自所选支付系统的付款。
• 状态 - 仅显示具有所选状态的付款。

付款表中的列列表：

• 应用程序 - 您的应用程序。您可以按照链接编辑其设置。
• # - 付款的唯一序列号。当用户从支付表单转到支付系统中的支付页面时，此序列号会自动分配给付款。您可以单击链接查看付款的详细信息。
• 备注 - 用户在付款表单中输入的消息。
• 系统 - 用户选择的支付系统。
• 状态 - 付款状态。 (查看付款状态)
• 电子邮件 - 用户在付款表单中填写的电子邮件地址。
• 期限 - 发送的代码的有效期（在应用程序设置中指定）。
• 创建时间 - 付款创建日期。
• 发票金额 - 用户支付的金额。根据应用设置在付款表单中指定。
• 付款日期 - 付款日期。
• 付款金额 - 支付系统确认的支付金额。
• 发送的代码 - 发送给用户的代码。
• 可用金额 - 可提取金额。
• 支付金额 - 用于付款的提取金额。

无法更改付款。

付款状态

在其生命周期内，支付会进入不同的状态，可以通过支付状态进行跟踪。

提款

当您进入此部分时，将打开您的提款列表。

提款列表

用户的上次使用的过滤器将被存储。也就是说，下次进入页面时，将自动应用上次使用的过滤器。提款列表可用的过滤器包括：

• 列 - 在提款列表中仅显示选定的列。
• 状态 - 仅显示处于选定状态的提款。

提款表中的列列表：

• # - 提款的唯一序列号。当提款保存时，它会自动分配给提款。您可以单击链接查看提款的详细信息。
• 状态 - 提款状态。 (查看提款状态)
• 创建时间 - 提款请求的日期。
• 金额 - 提款金额。
• 提款 - 提款发送的日期。
• 提款操作的按钮。例如，确认。

您可以在提现处于已发送状态时确认提现。

提款状态

提现在其生命周期中会进入不同的状态，可以通过提现状态进行跟踪。