跳转到主要内容

​
概述

CodeGate SDK API 提供项目信息、激活码查询、核销、重新激活、统计等接口。所有接口均需使用 API Key + HMAC-SHA256 签名 认证。 推荐优先使用 Python SDK 或 JavaScript SDK，无需手写签名逻辑。

​
认证方式

每个请求需在 HTTP Header 中携带：
Header说明
X-API-KeyAPI Key（32 位 UUID，无连字符）
X-TimestampUnix 时间戳（秒级）
X-SignatureHMAC-SHA256 签名（十六进制小写，64 字符）
签名字符串格式： 
{METHOD}\n{PATH}\n{QUERY_STRING}\n{BODY_SHA256_HEX}\n{TIMESTAMP}
  • 无 body 时使用空串的 SHA256：e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
  • 时间戳需在 ±5 分钟内，防止重放攻击

​
端点速查

方法路径用途
GET/api/v1/projects/{project_id}项目信息
GET/api/v1/projects/{project_id}/codes分页查激活码
GET/api/v1/projects/{project_id}/codes/{code_id}按 ID 查单个
GET/api/v1/projects/{project_id}/codes/by-code/{code}按内容查单个
POST/api/v1/projects/{project_id}/codes/verify核销
POST/api/v1/projects/{project_id}/codes/reactivate重新激活
GET/api/v1/projects/{project_id}/statistics统计信息

​
业务错误码（核销/重新激活）

响应中 success=false 时，error_code 可能为：
错误码含义
CODE_NOT_FOUND激活码不存在
CODE_ALREADY_USED已使用（核销时）
CODE_ALREADY_UNUSED已是未使用（重新激活时）
CODE_DISABLED已禁用
CODE_EXPIRED已过期
PROJECT_DISABLED项目已禁用
PROJECT_EXPIRED项目已过期

​
HTTP 状态码

状态码说明
200请求成功
400参数错误
401认证失败
403project_id 与 API Key 不匹配
404资源不存在
429限流
500服务器错误