トップ / API 連携ドキュメント

API連携ドキュメント

バージョン v1 · 代理店・開発者向け

APIを使うと、プログラムから本サイトで注文し、注文照会やコード取得ができます。注文金額はアカウント残高から直接差し引かれ、注文ごとの支払いは不要です。

  1. アカウント登録、 マイページ 残高をチャージします。
  2. を マイページ → APIインターフェース キーを作成すると、次が得られます: AppID と Secret。IPホワイトリストも併せて設定することをおすすめします。
  3. 下記の署名方式でAPIを呼び出してください。
APIエンドポイントhttps://vynqlo.com/api/open/v1
データ形式リクエストとレスポンスはどちらもJSON、文字コードはUTF-8です
金額の単位人民元(元)、小数点以下2桁まで
呼び出し頻度各キーにつき1秒あたり最大10回まで。超えると次を返します: 429

署名方式

すべてのリクエストに、次の4つのヘッダーが必要です:

リクエストヘッダー説明
X-App-IdあなたのAppID
X-Timestamp現在のUnixタイムスタンプ(秒)。サーバーとの差は300秒以内にしてください
X-Nonceランダム文字列(16~32文字)。同じ値は10分以内に再利用できません
X-Sign署名。計算方法は下記

次の5項目を改行で \n をつなげて、署名対象の文字列を作ります:

タイムスタンプ\nランダム文字列\nリクエストメソッド(大文字)\nリクエストパス(クエリパラメータを含む)\nリクエストボディ原文(GETリクエストの場合は空文字列)

もう一度 Secret HMAC-SHA256を計算し、結果を小文字の16進数にしたものが X-Sign。

Pythonのサンプル

import hmac, hashlib, json, time, secrets, requests APP_ID = "vq_xxxxxxxxxxxxxxxx" SECRET = "あなたのSecret" BASE = "https://vynqlo.com/api/open/v1" def call(method, path, body=None): raw = json.dumps(body, ensure_ascii=False, separators=(",", ":")) if body else "" ts, nonce = str(int(time.time())), secrets.token_hex(8) msg = "\n".join([ts, nonce, method, "/api/open/v1" + path, raw]) sign = hmac.new(SECRET.encode(), msg.encode(), hashlib.sha256).hexdigest() headers = {"X-App-Id": APP_ID, "X-Timestamp": ts, "X-Nonce": nonce, "X-Sign": sign, "Content-Type": "application/json"} return requests.request(method, BASE + path, headers=headers, data=raw.encode() or None).json() print(call("GET", "/balance"))

商品一覧

GET /products — 注文可能な全商品、あなたの仕入れ価格、在庫を返します。

{ "code": 0, "data": [ { "sku": "apple.us.25", "name": "Appleギフトカード · 米国 $25", "delivery": "code", // code コード / link リンク代理決済 / username ユーザー名チャージ "price": 189.00, "stock": 167, // リンク代理決済・ユーザー名チャージの商品は null(在庫無制限) "fields": [] // 注文時に追加で送信するフィールド。「注文の作成」を参照 } ] }

残高照会

GET /balance

{ "code": 0, "data": { "balance": 2380.50 } }

注文の作成

POST /orders — 残高が足りていれば、すぐに引き落として処理を開始します。

パラメータ必須説明
skuはい商品コード。末尾の「商品コード一覧」を参照
quantityいいえ数量。デフォルトは1。コード商品は1回の注文で最大10、その他の商品は1のみ
out_trade_noはいお客様のシステム側の注文番号(英数字6~64文字)。同じ番号で再送信しても既存の注文が返るだけで、二重に引き落とされることはありません
account_emailリンク代理決済は入力必須お客様のアカウントのメールアドレス
checkout_urlリンク代理決済は入力必須公式の決済リンク
usernameユーザー名チャージは入力必須例:Telegramユーザー名 @name

リクエスト例:

{ "sku": "chatgpt.plus.1m", "out_trade_no": "A20261119001",
  "account_email": "user@example.com",
  "checkout_url": "https://chatgpt.com/checkout/..." }

返却例:

{
  "code": 0,
  "data": {
    "order_no": "VQ2611190001",
    "out_trade_no": "A20261119001",
    "status": "processing",
    "amount": 169.00,
    "balance": 2211.50
  }
}

注文照会

GET /orders/{order_no}、または GET /orders?out_trade_no=注文番号

{
  "code": 0,
  "data": {
    "order_no": "VQ2611190002",
    "out_trade_no": "A20261119002",
    "sku": "apple.us.25",
    "quantity": 2,
    "amount": 378.00,
    "status": "delivered",
    "cards": ["XXXX-XXXX-XXXX-XXXX", "YYYY-YYYY-YYYY-YYYY"],
    "created_at": 1795060000,
    "finished_at": 1795060003,
    "remark": ""
  }
}
status意味
processing引き落とし済み、処理中(代理決済・ユーザー名チャージの注文は通常5~30分)
deliveredコードを発行しました。 cards の中
completed代理決済またはユーザー名チャージが完了しました
failed処理に失敗しました。金額は残高に戻しました。理由は remark

コールバック通知

マイページでコールバックURLを設定すると、注文が次の状態になったとき delivered、completed または failed とき、私たちは POST 注文データをこのアドレスに送ります。内容は「注文照会」の返却内容と data と同じです。

  • 通知にも同じく X-App-Id、X-Timestamp、X-Nonce、X-Sign。署名方法は同じです。処理の前に必ず署名を検証してください。
  • 処理が成功したら、HTTP 200と次のテキストを返してください: success。失敗した場合は1、5、15、60分後に再送し、最大4回までです。
  • 同じ注文で通知が複数回届くことがあります。 order_no 重複を除く。

エラーコード

code説明
0成功
1001署名が正しくないか、リクエストヘッダーが不足しています
1002タイムスタンプが許容範囲を超えています
1003ランダム文字列の再利用
1004IPがホワイトリストにありません
2001商品コードが存在しないか、販売終了です
2002在庫切れ
2003必須項目が不足しているか、形式が正しくありません
3001残高不足
4001注文が存在しません
429リクエストが多すぎます

エラー時の返却形式:{ "code": 3001, "message": "残高不足" }

商品コード一覧

価格は現在の仕入れ価格です。 /products APIの返却内容が優先されます。

コード sku商品受け取り方法価格