工具服务器目前主要提供图形验证码以及 PC 端二维码以及微信、阿里云、支付宝等常用第三方接入支持。
一、安装部署
二、图形验证码三、PC 端二维码四、服务限流五、支付宝六、阿里云七、微信小程序八、微信公众号九、微信支付十、其它一、安装部署请选择适合您操作系统的版本进行下载:
下载配置文件以及相应版本软件后直接运行即可,如果操作系统需要 x
属性执行文件,则先执行 chmod +x
命令,比如:
> wget https://ddzeb.com/-dl/ddzeb-tool-server.yaml -O server.yaml
> wget https://ddzeb.com/-dl/ddzeb-tool-server.linux-amd64 -O server && chmod +x server
> nohup ./server &
二、图形验证码通过服务器端进行验证的安全图形验证码。
• CaptchaNew 创建验证码名称 | 类型 | 是否必选 | 示例值 | 说明 |
code | string | 是 | a0828x | 验证码 |
expires | string | 否 | 5m | 过期时间 |
名称 | 类型 | 示例值 | 说明 |
Token | string | abc98773 | 验证码凭证 |
• CaptchaDel 删除验证码名称 | 类型 | 是否必选 | 示例值 | 说明 |
token | string | 是 | abc98773 | 验证码凭证 |
• CaptchaValidate 匹配验证码名称 | 类型 | 是否必选 | 示例值 | 说明 |
input | string | 是 | 123654 | 用户输入验证码 |
token | string | 是 | abc98773 | 验证码凭证 |
名称 | 类型 | 示例值 | 说明 |
Result | integer | 1 | 匹配结果 1 为正常匹配 0 为不匹配 -1 为验证码已过期 |
三、PC 端二维码PC 端展示二维码,供手机端扫码并操作后返回 PC 端。
• TagNew 创建二维码凭证PC 端浏览器调用此 API 获得一个 Token,之后定期检查此 Token 有没有被赋予一个有效值,如果有则做相应处理。手机扫码后,进行相关处理,完成后对 Token 对应的二维码赋值内容。服务器重启后,所有二维码失效。
名称 | 类型 | 是否必选 | 示例值 | 说明 |
expires | string | 否 | 8m | 过期时间 |
其它参数,二维码内容 |
名称 | 类型 | 示例值 | 说明 |
Token | string | abc98773 | 二维码 Token |
• TagDel 删除二维码凭证名称 | 类型 | 是否必选 | 示例值 | 说明 |
token | string | 是 | abc98773 | 二维码凭证 |
• TagGet 获取二维码内容名称 | 类型 | 是否必选 | 示例值 | 说明 |
token | string | 是 | abc98773 | 二维码凭证 |
• TagSet 设置二维码内容名称 | 类型 | 是否必选 | 示例值 | 说明 |
token | string | 是 | abc98773 | 二维码凭证 |
二维码内容字段 |
四、服务限流主要提供流量配置以及判断是否通过限流检查接口。
• FlowGet 取得管道配置名称 | 类型 | 是否必选 | 示例值 | 说明 |
pipe | string | 是 | user#sms | 管道名称 |
名称 | 类型 | 示例值 | 说明 |
Pipe | string | user#sms | 管道名称 |
Rate | float | 0.45 | 流量速率 |
Burst | integer | 15 | 超限允许量 |
• FlowPass 流量检测名称 | 类型 | 是否必选 | 示例值 | 说明 |
pipe | string | 是 | user#sms | 管道名称 |
timeout | string | 否 | 3s | 等待超时 |
通过流量检测,返回 reterr=="SUCCESS",否则返回错误。
• FlowSet 设置管道配置名称 | 类型 | 是否必选 | 示例值 | 说明 |
pipe | string | 是 | user#sms | 管道名称 |
rate | float | 是 | 0.45 | 流量速率 |
burst | integer | 是 | 12 | 超限允许量 |
名称 | 类型 | 示例值 | 说明 |
Pipe | string | user#sms | 管道名称 |
Rate | float | 0.45 | 流量速率 |
Burst | integer | 15 | 超限允许量 |
五、支付宝支付宝客户端支持。以下分别介绍相关 API:
• AlipayGet 取得配置名称 | 类型 | 示例值 | 说明 |
Gateway | string | https://openapi.alipaydev.com/gateway.do | 支付宝接口地址 |
AppID | string | 2016093808614753 | 应用 ID |
PrivateKey | string | -----BEGIN RSA PRIVATE KEY-----...... | 私钥 |
PublicKey | string | -----BEGIN PUBLIC KEY...... | 公钥 |
• AlipayInvoke 调用支付宝接口• AlipaySet 设置配置名称 | 类型 | 是否必选 | 示例值 | 说明 |
gateway | string | 是 | https://openapi.alipaydev.com/gateway.do | 支付宝接口地址 |
appid | string | 是 | 2016093808614753 | 应用 ID |
private-key | string | 是 | -----BEGIN RSA PRIVATE KEY-----...... | 私钥 |
public-key | string | 是 | -----BEGIN PUBLIC KEY...... | 公钥 |
六、阿里云阿里云客户端支持。以下分别介绍相关 API:
• AliyunGeoIP 地理位置服务名称 | 类型 | 是否必选 | 示例值 | 说明 |
ip | string | 是 | 133.25.10.165 | 所要查询的 IP 地址 |
名称 | 类型 | 示例值 | 说明 |
阿里云 IP 地理位置服务接口返回数据 |
• AliyunGet 取得配置名称 | 类型 | 示例值 | 说明 |
KeyID | string | 2016093808614753 | 应用 ID |
Secret | string | xier39482ksklf82348ks | 密钥 |
• AliyunInvoke 调用阿里云接口名称 | 类型 | 是否必选 | 示例值 | 说明 |
api-gameway-url | string | 是 | http://dysmsapi.aliyuncs.com/?Action=SendSms | 接口网关 |
阿里云接口参数 |
• AliyunMail 发送邮件名称 | 类型 | 是否必选 | 示例值 | 说明 |
account-name | string | 是 | ddzeb | 账号名称 |
to-address | string | 是 | admin@ddzeb.com | 邮件接收方 |
subject | string | 是 | Hi there | 邮件标题 |
text-body | string | 是 | Let's have dinner together. | 邮件正文 |
• AliyunMobileQuery 手机号查询名称 | 类型 | 是否必选 | 示例值 | 说明 |
mobile | string | 是 | 13347325566 | 所要查询的手机号 |
• AliyunSet 设置配置名称 | 类型 | 是否必选 | 示例值 | 说明 |
key-id | string | 是 | kx483kxjvsdf455 | 阿里云 Key ID |
secret | string | 是 | 2016093808614753 | 密钥 |
• AliyunSMS 发送短信名称 | 类型 | 是否必选 | 示例值 | 说明 |
sign-name | string | 是 | 湖南滴滴网络科技有限公司 | 签名名称 |
mobile | string | 是 | 18678665900 | 手机号 |
template-code | string | 是 | captcha | 短信模版名 |
template-params | JSON | 是 | captcha | 短信模版参数 |
七、微信小程序微信小程序客户端支持。以下分别介绍相关 API:
• WxMiniAuth 用户认证名称 | 类型 | 是否必选 | 示例值 | 说明 |
code | string | 是 | 021s2L000UHimM1NRD000xoz251s2L0o | jscode |
app-id | string | 否 | kx483kxjvsdf455 | 微信小程序 app-id |
secret | string | 否 | 2016093808614753 | 密钥 |
名称 | 类型 | 示例值 | 说明 |
openid | string | om-iG4uxJpqydAxEvKEeVp_evDcI | 微信 OpenID |
session_key | string | 2jstANNsEB3bxgep68qO8w== | js session key |
unionid | string | oBlSa55uU4C1fRoccznFoWPf0kvQ | 微信 unionid |
• WxMiniDecrypt 敏感数据解密名称 | 类型 | 是否必选 | 示例值 | 说明 |
session-key | string | 是 | 2jstANNsEB3bxgep68qO8w== | js session key |
encrypted-data | string | 是 | LeAZJAaR/ztXbsUMvDEG1+BSwJ5+7MGxgJkyxQ== | 加密数据 |
app-id | string | 否 | kx483kxjvsdf455 | 微信小程序 app-id |
secret | string | 否 | 2016093808614753 | 密钥 |
• WxMiniGet 取得配置名称 | 类型 | 示例值 | 说明 |
AppID | string | 2016093808614753 | 应用 ID |
Secret | string | xier39482ksklf82348ks | 密钥 |
• WxMiniSet 设置配置名称 | 类型 | 是否必选 | 示例值 | 说明 |
app-id | string | 是 | kx483kxjvsdf455 | 微信小程序 app-id |
secret | string | 是 | 2016093808614753 | 密钥 |
八、微信公众号微信公众号客户端支持。以下分别介绍相关 API:
• WxMpAuth 用户认证名称 | 类型 | 是否必选 | 示例值 | 说明 |
code | string | 是 | 021s2L000UHimM1NRD000xoz251s2L0o | jscode |
• WxMpAuthURL 用户认证 URL名称 | 类型 | 是否必选 | 示例值 | 说明 |
scope | string | 否 | snsapi_base | 请求授权范围 |
redirect-url | string | 是 | http://ddzeb.com/callback | 回调地址 |
名称 | 类型 | 示例值 | 说明 |
URL | string | http://... | 微信认证 URL |
• WxMpGet 取得配置名称 | 类型 | 示例值 | 说明 |
AppID | string | 2016093808614753 | 应用 ID |
Secret | string | xier39482ksklf82348ks | 密钥 |
• WxMpJsapiSign JSAPI 签名名称 | 类型 | 是否必选 | 示例值 | 说明 |
url | string | 否 | http://ddzeb.com | 待签名 URL |
名称 | 类型 | 示例值 | 说明 |
AppID | string | 2016093808614753 | 应用 ID |
Nonce | string | xier39482ksklf82348ks | 噪音 |
Time | string | 8238492834 | 时间戳 |
Sign | string | xier39482ksklf82348ks | 签名 |
• WxMpSet 设置配置名称 | 类型 | 是否必选 | 示例值 | 说明 |
app-id | string | 是 | kx483kxjvsdf455 | 微信小程序 app-id |
secret | string | 是 | 2016093808614753 | 密钥 |
• WxMpSubscribed 查询是否关注名称 | 类型 | 是否必选 | 示例值 | 说明 |
openid | string | 是 | kx483kxjvsdf455 | 用户 OpenID |
名称 | 类型 | 示例值 | 说明 |
Subscribed | bool | 1 | 是否已关注公众号 |
• WxMpTemplateMessage 发送模版消息名称 | 类型 | 是否必选 | 示例值 | 说明 |
openid | string | 是 | kx483kxjvsdf455 | 用户 OpenID |
template-id | string | 是 | kx483kxjvsdf455 | 模版 ID |
url | string | 是 | http://ddzeb.com | 消息 URL |
data | JSON | 是 | {Text:"Hello"} | 模版数据 |
• WxMpToken 获取 access_token 以及 jsapi_ticket名称 | 类型 | 示例值 | 说明 |
AccessToken | string | sdfkx482348jxj34nsdf | 微信公众号 access_token |
JsapiTicket | string | 8s8djf28v | 微信公众号 jsapi_ticket |
九、微信支付微信支付客户端支持。以下分别介绍相关 API:
• WxPayGet 取得配置名称 | 类型 | 示例值 | 说明 |
MerchantID | string | 9284767 | 商户 ID |
ApiKey | string | 9284767 | 接口凭证 |
SSLCert | string | ... | 安全连接 Certificate |
SSLKey | string | ... | 安全连接 Key |
• WxPayJsapi 接口调用名称 | 类型 | 是否必选 | 示例值 | 说明 |
app-id | string | 是 | kx483kxjvsdf455 | 微信应用 app-id |
url | string | 是 | https://wx.... | 接口地址 |
其它接口参数 |
为了方便程序调用,我们特别内置了如下特殊 url
值:
url | 说明 |
jsapi-unified-order | 统一下单 |
jsapi-order-query | 交易查询 |
jsapi-micro-pay | 刷卡支付 |
jsapi-refund | 退款 |
jsapi-refund-query | 退款查询 |
jsapi-reverse | 撤销订单 |
jsapi-close-order | 关闭订单 |
jsapi-withdraw | 企业付款到零钱 |
jsapi-share | 分账 |
jsapi-add-share-receiver | 添加分账接收方 |
jsapi-report | 交易保障 |
• WxPaySet 设置配置名称 | 类型 | 是否必选 | 示例值 | 说明 |
merchant-id | string | 是 | 46342346 | 商户 ID |
api-key | string | 是 | 46342346 | 接口凭证 |
ssl-cert | string | 是 | ... | 安全连接 Certificate |
ssl-key | string | 是 | ... | 安全连接 Key |
• WxPaySign 签名名称 | 类型 | 是否必选 | 示例值 | 说明 |
sign-type | string | 是 | MD5 | 签名类型 |
待签名的其它数据 |
名称 | 类型 | 示例值 | 说明 |
Sign | string | 8s83jg9wieorgjosdf0== | 签名数据 |
五、其它数据备份以及服务器状态监控
• ZReplicate 数据库备份名称 | 类型 | 是否必选 | 示例值 | 说明 |
dest | string | 是 | file-name.bak | 目标备份文件 |
• ZStat 服务器状态统计名称 | 类型 | 示例值 | 说明 |
ServerType | string | TOOL | 服务器类型 |
ServerVersion | string | 1.0 | 服务器版本 |
ServerName | string | ddzeb tool server | 服务器名称 |
APIs | []string | ["TagNew", "TagSet"] | 服务器 API 列表 |
StartAt | 时间 | 2314828874 | 启动时间 |
Database | JSON | {} | 数据库统计资料 |
Network | JSON | {} | 网络统计资料 |
Runtime | JSON | {} | 服务器运行时统计 |