マニュアル

導入

左側のサイドバーには、対応するセクションへのリンクが含まれています:

• ユーザー名 - 個人プロファイルへのリンク。
• ダッシュボード - チャートやグラフの形式で現在の状況を表示します。
• アプリケーション - アプリケーションの管理。
• ロック解除コード - 自動生成またはダウンロードしたアンロックコード。
• 支払い - ユーザーの受信支払い履歴。
• マニュアル - 現在のユーザーマニュアル。

ダッシュボード

ダッシュボードのすべてのウィジェットに共通のフィルターを設定できます:

• 通貨 - ダッシュボード上での受信および送信金額が変換される通貨。
• 期間 - ダッシュボードのチャートやテーブルに表示されるデータの期間。支払い、アプリケーション、その他のパラメータに関する情報と統計が分析および表示される期間を指定します。

残高

残高には以下の金額が含まれます:

• 総額 - 選択した期間のすべてのユーザー支払いの合計額（支払いシステムの手数料とPayToUseを除く）。
• 純額 - 選択した期間のすべての支払いの合計額（支払いシステムの手数料とPayToUseを除く）。
• 保留中の金額 - 開発者の口座への引き出し保留中の支払いシステムとPayToUseの手数料を差し引いた、指定期間のすべての支払いの合計額。支払いは支払い後7日後に引き出し可能となります。
• 利用可能な金額 - 支払いシステムの手数料とPayToUseを差し引いた、すべての期間のすべての支払いの合計額。開発者の口座への引き出し可能額。

支払い

支払いウィジェットには、選択した期間のアプリケーション別にグループ化された支払いのテーブルが含まれています。

テーブルのフィールド:

• アプリケーション - アプリケーション。選択した期間中に支払いが行われたアプリケーションのみがテーブルに表示されます。
• 支払い - 支払いの数。
• 総額 - 選択した期間のすべてのユーザー支払いの合計額（支払いシステムの手数料とPayToUseを除く）。
• 純額 - 選択した期間のすべての支払いの合計額（支払いシステムの手数料とPayToUseを除く）。

グラフは、純額 と 総額 の値の日別の動向を示します。

新規ユーザー

新規ユーザーのグラフは、日別の動向で2つの値を示します:

• 新規ユーザー - 新規API呼び出しの数。APIアクセスは、リクエストをAPIに送信する際に device パラメータ（ユニークなデバイス識別子）が渡された場合にのみ記録されます。このパラメータはデバイスごとに本当にユニークである必要があります。 （リクエストの送信 参照）
• 支払い - 同じ期間内の日別支払いの数。

変換

変換メトリクスは、新規ユーザー を 支払い に変換するための販売効率評価を指します。

グラフは、支払い の数と 新規ユーザー の数の割合をパーセントで示します。

アプリケーション

このセクションに移動すると、アプリケーションのリストが表示されます。

アプリケーションテーブルの列のリスト：

• # - ユニークなアプリケーション識別子。アプリケーションコードの検証や支払いフォームの表示時に使用されます。
• 名前 - アプリケーション名。レポートやダッシュボードであなただけに表示されます。アプリケーション名をクリックすると、アプリケーションの編集ページが開きます。
• 状態 - アプリケーションの現在のステータス。次のようになります：
• 作成済み - アプリケーションが作成されたばかりで、まだ設定されていません。
• リリース済み - アプリケーションが稼働中です。
• 作成済み - アプリケーションの作成日。
• 追加の制御ボタン：
• 削除 - アプリケーションをリストから削除するためのボタン。

アプリケーションの作成または編集

支払いを受けるためには、すべての必要なアプリケーションデータを適切に入力し、アプリケーションを有効にする必要があります。

新しいアプリケーションを作成するボタンは、アプリケーションリストのタイトルバーにあります。

アプリケーション

アプリケーションを作成する際に利用可能なフィールド：

• 名前 - レポートやダッシュボードであなただけが見ることができるアプリケーションの名前。保存されたアプリケーションのページヘッダーに表示されます。アプリケーションが保存されていない間は、「New app」と表示されます。このフィールドは入力必須です。
• 連絡先メール - ユーザーに送信されたメッセージのコピーが送信されるメールアドレス。このアドレスは「返信先」フィールドにも指定され、ユーザーがコード付きの受信メールに返信するために使用されます。このフィールドは入力必須です。デフォルトでは、開発者プロファイルの値が入力されますが、異なる値に変更することもできます。
• アプリケーションタイプ - アプリケーションのタイプ。グループタイプのアプリケーションを選択すると、グルーピング用にアプリケーションのリストが表示されます。リストには、アンロックコードが生成された個別のアプリケーションのみが利用可能です。
• 支払いに対するフィードバックを許可する - ユーザーが無料のテキストを入力するための支払いフォームにフィールドを追加します。フィードバックは開発者のメールのコピーに追加されます。支払いの詳細でもフィードバックを確認できます。

値を変更し始めると、保存ボタンが表示されます。保存ボタンをクリックすると、次のページに移動せずに変更を保存できます。次へボタンは変更を保存し、次のページに移動します。後で変更を加えるためにいつでも戻ることができます。

ページヘッダーでは、保存されたアプリケーションのページのみがナビゲーション可能です。次へをクリックするか、ページヘッダーのセクションに移動できます。

説明

リストから言語を選択し、追加ボタンをクリックします。

選択した言語のローカライズされたアプリケーションテキストのタブが表示されます。

利用可能な言語：

• ドイツ語
• 英語
• フランス語
• スペイン語
• ロシア語
• 中国語（簡体字）

説明文のフィールドは、支払いフォーム上やユーザーへの返信メッセージに情報を表示するために使用されます：

• 名前 - 選択された言語のアプリケーション名。支払いフォームおよび支払い通知メールに表示されます。言語を追加すると、デフォルトでアプリケーション名が挿入されます。各言語ごとに異なる名前を設定することができます。必須フィールドです。
• 説明 - アプリケーションの簡単な説明。アプリケーション名の下に支払いフォームに表示されます。オプションのフィールドです。説明を表示したくない場合は空白のままにしておくことができます。
• 返信 - 支払いが成功した場合にユーザーに送信される追加情報。応答テキストは標準の応答の後にメールの末尾に追加されます。

少なくとも1つの言語を追加して保存し、次のページに進む必要があります。

支払いフォームに表示される言語は、ユーザーがブラウザの設定で指定した好みに基づいて自動的に決定されます。アプリケーションの言語を保存することができます。

値を入力または変更し始めると、保存ボタンが表示されます。保存ボタンをクリックすると、次のページに進まずに変更内容を保存できます。次へボタンをクリックすると、変更を保存して次のページに移動します。後で変更を加えるためにいつでも戻ることができます。

ページヘッダーでは、保存されたアプリケーションのページのみがナビゲーション可能です。次へをクリックするか、ページヘッダーのセクションに移動できます。

価格

このページには価格の一覧と支払いに関連するフィールドが含まれています：

• 試用期間 - トライアル期間の長さ。
• 時間の単位 - トライアル期間の時間単位。例えば、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>

次に、Pay-to-use 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 - 2つの引数を受け入れるべきコールバックメソッドへのリンク：
• responseCode - サーバーレスポンスのヘッダーコード。
• data - リクエストが成功した場合のコンテンツ、またはnull。

API側のチェック

パラメータがAPIに渡されない場合、APIはHTTP/1.1 404 Not Foundヘッダーを返します。

少なくとも1つのパラメータがAPIに渡された場合、APIはHTTP/1.1 200 OKヘッダーを返します。

サーバーレスポンスは以下から成り立っています：

• response - レスポンスコード
• msg - レスポンスのテキストによる説明
• expires - UNIXTIMEタイムスタンプ（該当する場合）

渡されたアプリケーション識別子が正しいことを確認するためのチェックが行われます。 支払い時点でアプリケーションはリリース済みステータスである必要があります。 エラーの場合、レスポンスコード301が返されます。

ユニークなデバイスIDが送信された場合、そのデバイスIDが検索され、保存されます。 確認または保存時にエラーが発生した場合、エラーコード402が返されます。 このようなリターンコードが見つかった場合は、直ちに[email protected]にサポートに連絡してください

コードが渡された場合、期間に応じた価格計算および価格に応じた期間計算の計算方法を持つアプリケーションに対して以下のステップが実行されます：

• 空のコードが送信された場合、前のステップで定義されたユニークデバイス識別子から切り離されます。
• 非空のコードが送信され、アクティブ化されていない場合、購入時に指定された価格の条件に応じて、コードがアクティブ化されます。アクティブ化の日付に関係なく。
• コードが送信されなかった場合、または送信されたコードが見つからない場合、エラーコード201が返されます。
• アクティブ化されたコードはデバイスと照合され、アクティブ化中に保存されたものと異なるユニークデバイス識別子が送信された場合、エラーコード202が返されます。
• 送信されたコードに有効期限がなく、すべての前のチェックが合格した場合、コード101が返されます。
• コードが時間制限されている場合、チェックが行われます。キーが有効期限切れでない場合、コード101が返されます。コードが期限切れの場合、エラーコード203が返されます。
• このタイプのアプリケーションでは、コードをデバイスにバインドする必要があります。ユニークなデバイスIDが送信されていない場合、エラーコード304が返されます。

永続的なコードを持つアプリケーションの場合、購入時のコードの可用性のみがチェックされます。 コードが見つかれば、コード101が返されます。コードが見つからない場合、エラーコード201が返されます。

寄付計算方法を持つアプリケーションの場合、コードはチェックされません。 コード101が常に返されます。

前のチェックに合格していない場合、テスト期間がチェックされます。 デバイスが最初に接触してからの経過時間が現在のアプリケーション設定よりも長い場合、エラーコード204が返されます。 試用期間がまだ終了していない場合、エラーコード102が返されます。

アプリケーションIDのみが送信され、アンロックコードもユニークデバイスIDも送信されない場合、エラーコード303が返されます。

返されたレスポンスが500の場合、[email protected]にサポートに連絡する必要があります

以下にすべての返されるコードの表があります：

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

{
	"response":101,
	"msg":"Active until 18 Oct 2024",
	"expires":1729218192
}

{
	"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 17h 47m",
	"expires":1725999063
}

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

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

{
	"response":203,
	"msg":"Expiration: 5 Aug 2024",
	"expires":1722824592
}

{
	"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の不具合です
			// 有料機能が利用可能です
			...
		}
	}
}

ロック解除コード

このセクションに移動すると、アンロックコードのリストが表示されます。

アンロックコードのリスト

トップの検索バーで電子メールフィールドまたはコードを検索できます。見つかったコードはリストに表示されます。電子メールまたはコードの全体または一部を検索基準として使用できます。一致する部分は色で強調表示されます。検索とフィルターは同時に動作し、互いを排除しません。

最後に使用したフィルターはユーザーのために保存されます。つまり、次回ページにアクセスすると、最後に使用したフィルターが自動的に適用されます。アンロックコードのリストには、以下のフィルターがあります：

• 列 - アンロックコードのリストで表示するテーブル列を選択します。
• アプリケーション - 選択したアプリケーションのアンロックコードのみを表示します。
• 状態 - 選択したステータスにあるアンロックコードのみを表示します。

アンロックコードのテーブルの列のリスト：

• アプリケーション - あなたのアプリケーション。リンクをたどってその設定を編集できます。
• コード - アンロックコード。
• Eメール - アンロックコードの登録に関連付けられたメールアドレス。このアドレスは、ウェブサイトの私の購入セクションで顧客のアンロックコードを検索するために使用されます。このセクションはユーザーにアクセス可能です。
• 期間 - 送信されたコードの有効期間（アプリケーション設定で指定）。コードの有効期間は、その作成時点でのアプリケーション設定の条件に対応して設定されます。
• 状態 - アンロックコードのステータス。 （アンロックコードのステータス 参照）
• 作成済み - アンロックコードの作成日。
• アクティブ化 - コードのアクティベーション日付。この特定のユーザーデバイスが最初にPayToUse APIサービスに連絡し、このコードを送信した時点で設定されます。コードのステータスはアクティブ化に変更されます。非アクティブなコードのみをアクティベーションできます。異なるIDを持つデバイスがアクティブなコードを送信した場合、APIはエラー202を返します。1つのコードには1つのデバイスのみをリンクできます。
• 有効期限 - コードのアクティベーションが有効期限切れになる日付。コードのアクティベーション時に有効期限が設定されるコードに対して設定されます。無期限の場合は空白のままです。
• 削除済み - コードの削除日付。削除時にコードのステータスが不明に設定されます。
• 支払い # - 支払いの一意のシーケンス番号。リンクをクリックして支払いの詳細を表示できます。
• アンロックコードに関する操作用のボタン。例えば、削除。

アンロックコードのステータス

アンロックコードはそのライフサイクルの中で異なる状態を経験し、それらはコードのステータスによって追跡することができます。

支払い

このセクションに移動すると、ユーザーの支払いのリストが開きます。

支払いを受け取るために以下の支払いシステムが使用されています:

支払いシステムの手数料を差し引いた後、PayToUseは13%の手数料を請求します。手数料を削減するために常に取り組んでいます。

支払いシステムで紛争や払い戻しが発生した場合、支払いシステムのペナルティが開発者に再発行されます。したがって、このような状況が発生しないようにする必要があります。紛争がある場合、PayToUseは手数料を請求しません。

支払いリスト

トップの検索バーでメールフィールドまたは送信されたコードを検索できます。見つかった支払いはリストに表示されます。メールアドレスまたは送信されたコードの全体または一部を検索条件として使用できます。一致するものは色で強調表示されます。検索とフィルタは同時に動作し、互いに排他的ではありません。

ユーザーのために最後に使用されたフィルタが保存されます。つまり、次回ページに入ると、最後に使用されたフィルタが自動的に適用されます。支払いのリストには以下のフィルタがあります:

• 列 - 支払いリストに表示するテーブル列を選択します。
• アプリケーション - 選択したアプリケーションの支払いのみを表示します。
• システム - 選択した支払いシステムからの支払いのみを表示します。
• 状態 - 選択したステータスの支払いのみを表示します。

支払いテーブルの列のリスト:

• アプリケーション - あなたのアプリケーション。リンクをたどってその設定を編集できます。
• # - 支払いの一意の連番です。ユーザーが支払いフォームから支払いページに移動する際に、支払いシステムで自動的に割り当てられます。支払いの詳細を表示するにはリンクをクリックしてください。
• コメント - 支払いフォームに入力されたユーザーからのメッセージ。
• システム - ユーザーが選択した支払いシステム。
• 状態 - 支払いのステータス。 （支払いのステータス 参照）
• Eメール - 支払いフォームに記入されたユーザーのメールアドレス。
• 期間 - 送信されたコードの有効期間（アプリケーションの設定で指定）。
• 作成済み - 支払いの作成日。
• 請求金額 - ユーザーに請求された支払いの金額。アプリケーションの設定によって支払いフォームに指定されます。
• 支払い日 - 支払い日。
• 支払い金額 - 支払いシステムによって確認された支払いの金額。
• 送信されたコード - ユーザーに送信されたコード。
• 利用可能な金額 - 出金可能額。
• 支払い金額 - 支払いのための引き出し資金の金額。

支払いに変更を加えることはできません。

支払いのステータス

支払いはそのライフサイクルの中で異なる状態に移行し、支払いのステータスで追跡できます。

引き出し

このセクションに移動すると、引き出しリストが表示されます。

引き出しリスト

最後に使用したフィルターがユーザーのために保存されます。つまり、次回ページにアクセスすると、最後に使用したフィルターが自動的に適用されます。引き出しリスト用のフィルターは以下の通りです：

• 列 - 引き出しリストで選択した列のみ表示します。
• 状態 - 選択したステータスにある引き出しのみ表示します。

引き出しテーブルの列の一覧：

• # - 引き出しの固有シーケンス番号。引き出しを保存すると自動的に割り当てられます。リンクをクリックして引き出しの詳細を表示できます。
• 状態 - 引き出しのステータス。 （引き出しステータス 参照）
• 作成済み - 引き出しリクエストの日付。
• 金額 - 引き出し金額。
• 引き出し - 引き出しが送信された日付。
• 出金に関連するアクションのボタン。例えば、確認。

出金が送信済みの状態の場合、出金を確認できます。

引き出しステータス

出金のライフサイクル中、異なる状態になります。これらの状態は、出金のステータスで追跡できます。