首页 / API 调用文档

API 调用文档

请使用 HTTPS,请求方式为 POST,正文为 JSON(UTF-8)。是否成功以返回里的 success 为准。

概述与约定

基础地址:https://你的域名

请求
POST
请求头
Content-Type: application/json
响应
JSON · utf-8

返回结构data 可有可无):

{
  "success": true | false,
  "message": "说明文字",
  "data": { }
}

卡密验证 POST /api/verify.php

首次验证成功会记为已使用;已使用或过期时返回不同,部分情况带 data

POST https://你的域名/api/verify.php

请求参数(Body JSON)

「JSON 类型」列表示该字段在 JSON 里是文本(string),不是固定词「字符串」;实际要传的内容见「说明」列(你的 api_keycard_key 等)。

参数JSON 类型必填说明
api_keystring你的 API 密钥
card_keystring待验证的卡密
user_infostring可选备注,如设备号
注意频率:请勿短时间高频调用;触发限流时将暂时拒绝请求,稍后再试。

data 常见字段

字段说明
card_typeduration随业务返回,取值以实际为准
used_atexpire_at时间相关字段(若有)
is_used是否曾核销;与 success 组合判断,须核对 本字段

说明

  • success 为 true:新验证与重复验证的语义不同,须结合 data.is_used 与返回说明区分。
  • successfalse:参数、限流、密钥、卡状态错误等,务必查看 message

示例

{
  "success": true,
  "message": "…",
  "data": { "card_type": "…", "duration": 0, "is_used": false }
}
{ "success": false, "message": "…" }

卡密查询 POST /api/query.php

仅查询、不核销。只需 card_key,不需要 api_key。类型与状态为中文文案。

POST https://你的域名/api/query.php
参数必填
card_key

示例代码(验证接口)

替换为你的域名与密钥;查询接口则换 URL,请求体只需 card_key

const url = "https://你的域名/api/verify.php";
const res = await fetch(url, {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    api_key: "your_api_key",
    card_key: "your_card_key",
  }),
});
console.log(await res.json());