チャージコード

メソッド、リクエストのフィールド、レスポンス。

完全ガイド

このセクションには2メソッドがあります。メソッドを開くと、アクセス条件、リクエストのフィールド、レスポンスを確認できます。

メソッドとパス	説明	アクセス
`POST /api/v1/redeem`	コードの引き換え	ダッシュボードのトークン
`GET /api/v1/redeem/history`	引き換え履歴	ダッシュボードのトークン

POST /api/v1/redeem — コードの引き換え

アクセス：ダッシュボードのトークン

POST/api/v1/redeem

JSON／フォームのフィールド

フィールド	タイプ	必須	検証／説明
`code`	`string`	はい	required

リクエストボディのテンプレート

{
  "code": "PLACEHOLDER_CODE (string)"
}

PLACEHOLDERは、入力する値とその型を示します。値を置き換え、必要な任意フィールドだけを残してください。数値、boolean、オブジェクト、配列の代わりに、文字列のマーカーを送信しないでください。

リクエストのスキーマ：RedeemRequest

レスポンス

JSONレスポンスにはcode、message、dataが含まれます。dataの内容は、以下のスキーマで説明します。

レスポンスのデータスキーマ：RedeemCode。フィールドと型は、「データスキーマ」の各ページに記載されています。

レスポンスのスキーマ。値は例示用

{
  "code": 0,
  "message": "success",
  "data": {
    "id": "PLACEHOLDER_ID (integer)",
    "code": "PLACEHOLDER_CODE (string)",
    "type": "PLACEHOLDER_TYPE (string)",
    "value": "PLACEHOLDER_VALUE (number)",
    "status": "PLACEHOLDER_STATUS (string)",
    "used_by": "PLACEHOLDER_USED_BY (integer)",
    "used_at": "PLACEHOLDER_USED_AT (string)",
    "created_at": "PLACEHOLDER_CREATED_AT (string)",
    "expires_at": "PLACEHOLDER_EXPIRES_AT (string)",
    "validity_days": "PLACEHOLDER_VALIDITY_DAYS (integer)",
    "notes": "PLACEHOLDER_NOTES (string)",
    "user": "PLACEHOLDER_USER (object)"
  }
}

補足：すべての個人データとオブジェクトは、JWTの主体に限定されます。

補足：この操作は状態を変更するか、一度限りの認証手続きを継続します。例は契約仕様を説明するもので、実行されません。

GET /api/v1/redeem/history — 引き換え履歴

アクセス：ダッシュボードのトークン

GET/api/v1/redeem/history

取得。IDは、以前取得したレスポンスの値を使います。

curl --fail-with-body "https://ailoot.ai/api/v1/redeem/history" \
  -H "Authorization: Bearer $TOKEN"

クエリパラメータ

フィールド	タイプ	必須	検証／説明
`page`	`integer`	いいえ	；デフォルト：1；正の整数
`page_size`	`integer`	いいえ	；デフォルト：20；正の整数；100に制限

リクエストボディは不要です。上記のパラメータはURLで渡してください。