⚙️API

リアルタイムデータの取得

1. データの取得

2. ユーザーステータスの取得

Endpoint

Endpoint /client/data/status

クエリ

クエリ
アイテム名
記述

apiKey

api key

required

戻り値(出力)

  1. 現在の月のアクティブユーザー

  2. 現在の月に登録されたユーザー

  3. 今月のユーザーの取り消し

  4. すべて

  5. アクティブなキャンセル予定のユーザー(ユーザーが解除済み)

  6. 解除済み

例のレスポンス

{ "data": { "currentMonthActiveUsers": 501, "currentMonthRegisteredUsers": 0, "currentMonthInactiveUsers": 0, "allUser": 503, "activeUsers": 501, "intendCancelUsers": 0, "unsubscribedUsers": 2 }, "message": "Success", "statusCode": 200 }

3. ユーザーリストの取得

Endpoint

Endpoint /client/data/members

クエリ

クエリ
アイテム名
記述

page

ページを戻す

default: 1 min: 1

limit

1ページに表示するアイテム数を制限

default: 1 min: 1 max: 1

apiKey

api key

required

戻り値(出力)

  1. 登録日

  2. 状況

  3. メールアドレス

  4. 0xアドレス

  5. 最後の成功した支払い

  6. 支払い回数

例のレスポンス

{ "data": { "items": [ { "address": "0x57ef6f871888e2d294470a0061292675f6dc309c", "email": "[email protected]", "agreementStatus": false, "agreementDate": "2023-06-08T04:53:37.812Z", "chargeTime": 2, "lastChargeSuccess": "2023-06-06T08:15:34.290Z" }, { "address": "0x8dad6c0483657a12111f8266ca1f9e8a93aeb3fe", "email": "[email protected]", "agreementStatus": false, "agreementDate": "2023-06-08T01:49:32.656Z", "chargeTime": 0, "lastChargeSuccess": null } ], "totalItems": 100, "page": 1, "limit": 2, "totalPages": 50 }, "message": "Success", "statusCode": 200 }

4. ユーザー詳細の取得

Endpoint

Endpoint /client/data/members/{userAddress}

パラメータ(入力)

パラメータ
アイテム名
記述

userAddress

ユーザーアドレス

required

クエリ

クエリ
アイテム名
記述

apiKey

api key

required

戻り値(出力)

ユーザーアドレスに関連する詳細情報の取得

  1. 登録日

  2. 状況

  3. メールアドレス

  4. 0xアドレス

  5. 支払い回数

  6. 全額月額支払い

例のレスポンス

{ "data": { "address": "0x57ef6f871888e2d294470a0061292675f6dc309c", "email": "[email protected]", "agreementStatus": false, "agreementDate": "2023-06-08T04:53:37.812Z", "chargeTime": 2, "chargeTotal": 20 }, "message": "Success", "statusCode": 200 }

5. ユーザーの支払い履歴の取得

Endpoint

Endpoint /client/data/members/payment/{userAddress}

パラメータ(入力)

パラメータ
アイテム名
記述

userAddress

ユーザーアドレス

required

クエリ

Query
アイテム名
記述

page

ページを戻す

default: 1 min: 1

limit

1ページに表示するアイテム数を制限

default: 1 min: 1 max: 1

apiKey

api key

required

戻り値(出力)

ユーザーアドレスに関連する支払い情報の取得

  1. 支払い日時

  2. 支払い金額

  3. 支払いステータス

例のレスポンス

{ "data": { "items": [ { "amount": 10, "chargedAt": "2023-06-06T08:15:34.290Z", "chargedStatus": "success" }, { "amount": 10, "chargedAt": "2023-06-06T07:34:49.734Z", "chargedStatus": "success" } ], "totalItems": 2, "page": 1, "limit": 2, "totalPages": 1 }, "message": "Success", "statusCode": 200 }

Last updated