API Docs

开放 API 开发文档

通过 HTTP 接口接入「三度密语加密」能力。当前版本(v1.3.3)开放文字加解密与密语对比,图片 / 音频接口将在后续版本提供。

1接入流程

第一步:注册账号并登录,进入「个人中心 → API 管理」,点击「申请开通 API」。

第二步:等待管理员审核通过(若站点开启自动审核则即时生效),获得 App Key 与 App Secret。

第三步:按下方规则对请求签名,将参数以 POST 方式提交到接口地址。

接口地址(请将域名替换为你的站点):

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

2鉴权与签名

每个请求都必须携带以下鉴权参数,服务器会校验时间戳、密钥与签名,任一不符即拒绝。

参数必填说明
app_key必填应用标识,个人中心获取
timestamp必填当前秒级时间戳,与服务器偏差需在 ±600 秒内
nonce必填随机字符串,每次请求唯一
sign必填HMAC-SHA256 签名,见下

签名计算步骤:

# 1. 取除 sign 外的全部参数,按参数名 ASCII 升序排列 # 2. 依次拼接为 key=value(首尾无分隔符) # 3. 在最前面补上 App Secret,得到待签名字符串 string_to_sign = AppSecret + "action=text_encrypt" + "app_key=xxx" + ... # 4. 以 App Secret 为密钥做 HMAC-SHA256,输出十六进制小写 sign = HMAC_SHA256(string_to_sign, AppSecret)

注意:计算签名时 包含 app_key、timestamp、nonce 与全部业务参数,仅 不包含 sign 本身。

3接口列表

action功能关键参数返回
text_encrypt文字加密text、style、keyscipher
text_decrypt密语解密cipher、style、keysplain
compare对比两段密语是否同源cipherA、cipherB、keyssame
strength评估口令强度keyscore / level
stats查询本账号调用统计—调用次数

4业务参数

参数必填说明
action必填接口名称
text加密必填要加密的明文
cipher解密必填要解密的密语
cipherA / cipherB对比必填待对比的两段密语
keys可选口令;加密时填了,解密时必须一致,留空表示无口令
style可选密语风格:emoji(默认)、num、sym

5响应格式

统一返回 JSON,code 为 0 表示成功,非 0 表示失败,msg 为提示,data 为业务数据。

// 成功 {"code":0,"msg":"ok","data":{"cipher":"🧩🌸🍃…","style":"emoji"}} // 失败 {"code":400,"msg":"密文无效。","data":null}

6调用示例


  

7错误码与状态

HTTP 状态含义排查建议
200请求成功读取 data
401鉴权失败检查 App Key、时间戳、签名、审核与启用状态
429触发限流默认每分钟 60 次,请降低频率
200 + code 400业务错误按 msg 提示修正参数