IconCreated with Sketch.

YAPI 接口文档

YApi
  • V1接口
    • 域名授权检测接口
    • 获取最新版本接口
  • V2接口
    • 卡密信息V2接口
    • 卡密核销V2接口
    • 域名授权检测V2接口
    • 服务监测V2接口
    • 获取最新版本V2接口(返回下一个版本)
  • V3接口
    • 下单支付V3接口
    • 卡密核销V3接口(需要验签)
    • 域名授权检测V3接口(需要验签)
    • 服务监测V3接口
    • 查询授权信息V3接口
    • 获取商品列表V3接口
    • 获取最新版本V3接口(返回下一个版本)
    • 获取项目列表V3接口
    • 获取验证码V3接口
    • 账号登录V3接口(需要验签)

授权系统

授权系统主要用于项目授权,其他系统的授权可以直接在授权系统上进行管理,支持离线的RSA授权,支持域名在线授权,项目目的主要是为了帮助个人开发者实现系统授权功能,让开发者能更好的对自己的产品进行保护。

公共信息

一、项目说明

在数字产品蓬勃发展的当下,个人开发者常面临系统授权功能开发复杂、版权保护困难等问题。我们的授权系统正是为解决这些痛点而生,致力于为个人开发者提供全面、高效的授权解决方案。
本系统支持RSA 离线授权、在线域名授权、卡密授权三种核心授权模式。RSA 离线授权通过非对称加密技术,即使在无网络环境下也能保障软件授权安全;在线域名授权可精准绑定域名,防止非法使用,适用于网站应用;卡密授权则以灵活便捷的形式,方便用户通过兑换卡密获取授权,满足多样化的业务场景需求。
在项目管理层面,强大的项目版本管理功能是一大亮点。开发版本检测接口能够实时获取项目最新版本和下载地址,不仅有助于开发者及时推送更新,确保用户使用到最稳定、功能最完善的产品,还能让开发者对项目版本迭代进行高效管控,提升产品竞争力。
此外,系统具备高度的集成能力,可与支付系统无缝衔接。用户能够在授权中心自主完成下单授权操作,极大简化交易流程,有效提升用户体验。这一特性不仅方便了用户,还能加速开发者的资金回笼,实现商业变现的高效运转。
总之,我们的授权系统以功能全面、操作便捷、安全可靠的优势,为个人开发者提供从授权管理到交易变现的一站式服务,助力开发者将更多精力投入到产品开发创新中,在数字市场中稳步前行。
系统官网:http://www.uvstu.com

二、签名生成规则(V3接口使用)

用户创建应用后,系统会自动生成签名key,签名加密的时候需要加入应用生成的签名key, 不同的应用签名key不一样。
本平台的签名统一使用MD5加密进行签名,签名规则为 MD5(签名key+请求参数+签名Key)
案例如下:

JSON参数:{"a1":"1234567890","a2:":"xxx","a3":123} 签名KEY:12345678901234567890123456789012
加密数据拼接:12345678901234567890123456789012{"a1":"1234567890","a2:":"xxx","a3":123}12345678901234567890123456789012

将以上加密数据拼接结果进行MD5加密即可生成签名
签名结果:3928173ab21128aa11cc225560594a12

V1接口

域名授权检测接口

基本信息

Path: /auth/open/api/auth

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
authNostring必须授权编号
domainNamestring必须域名地址

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedstring必须业务是否请求成功,成功-true 失败-false
datastring必须签名信息,用于客户端验签,MD5(授权编号+","+域名地址)

获取最新版本接口

基本信息

Path: /auth/open/api/version

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
entryNostring必须项目编号

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedstring必须业务是否请求成功,成功-true 失败-false
dataobject必须版本数据
├─ versionNumberstring必须当前版本
├─ updateUrlstring必须更新地址
├─ versionDescribestring必须版本描述
├─ extraParamstring必须额外参数
├─ createTimestring必须创建时间
├─ keystring必须签名信息,用于客户端验签,MD5(项目编号+","+域名地址)

V2接口

卡密信息V2接口

基本信息

Path: /auth/open/api/v2/card/info

Method: POST

接口描述:

卡密状态

1-未使用 2-已使用

授权类型

1-域名授权 2-RSA授权

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
cardstring必须卡密编号

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedstring必须业务是否请求成功,成功-true 失败-false
dataobject必须返回数据
├─ cardInfoobject必须卡密信息
├─ batchNamestring必须批次名称
├─ cardNostring必须卡密编号
├─ statusinteger必须状态
├─ goodInfoobject必须商品信息
├─ goodNamestring必须商品名称
├─ authTypeinteger必须授权类型
├─ timeTypeinteger必须时间类型
├─ effectiveTimestring必须有效时间
├─ pricestring必须商品价格
├─ customizestring必须自定义参数

卡密核销V2接口

基本信息

Path: /auth/open/api/v2/card

Method: POST

接口描述:

key 组成

卡密+"x|asb"+验证码+"x|asb"+旧激活码(没有就传空字符串  "" )

注意

关于续期激活 和 不续期激活的区别
1、续期激活
(1)需要携带旧激活码
(2)续期要求卡密的 商品额外参数 必须和卡密的 商品额外参数 一致才能续期成功
2、不续期激活
(1)不携带旧激活码

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
keystring必须授权串,具体请看下方备注

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedstring必须业务是否请求成功,成功-true 失败-false
datastring必须激活码信息

域名授权检测V2接口

基本信息

Path: /auth/open/api/v2/auth

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
authNostring必须授权编号
domainNamestring必须域名地址

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedstring必须业务是否请求成功,成功-true 失败-false
datastring必须签名信息,用于客户端验签,使用项目公钥进行解密

服务监测V2接口

基本信息

Path: /auth/open/api/v2/server

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
entryNostring必须项目编号
accessAddressstring必须项目访问地址
authStatusinteger必须授权状态

返回数据

名称类型是否必须默认值备注其他信息

获取最新版本V2接口(返回下一个版本)

基本信息

Path: /auth/open/api/v2/version

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
entryNostring必须项目编号
versionstring必须当前版本号

返回数据

名称类型是否必须默认值备注其他信息
codeinteger必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedstring必须业务是否请求成功,成功-true 失败-false
dataobject必须版本数据
├─ versionNumberstring必须当前版本
├─ updateUrlstring必须更新地址
├─ versionDescribestring必须版本描述
├─ extraParamstring必须额外参数
├─ createTimestring必须创建时间
├─ keystring必须签名信息,用于客户端验签,MD5(项目编号+","+域名地址)

V3接口

下单支付V3接口

基本信息

Path: /auth/v3/pay

Method: POST

接口描述:

注意:头部需要携带登录成功后返回的token凭证

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
appid 1676056269929 是 应用ID
sign 123718923789173121 是 签名
token 123123213131111 是 鉴权Token,登录成功后返回的

Body

名称类型是否必须默认值备注其他信息
goodIdstring必须商品ID
authValuestring必须客户端生成的验证码
payTypestring必须支付类型 1-支付宝 2-微信

返回数据

名称类型是否必须默认值备注其他信息
codestring必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedstring必须业务是否请求成功,成功-true 失败-false
dataobject必须返回结果
├─ outTradeNostring必须订单号
├─ payUrlstring必须支付地址

卡密核销V3接口(需要验签)

基本信息

Path: /auth/v3/card

Method: POST

接口描述:

签名方式请看WIKI
注意:验签是使用返回的 data 中的 data 数据进行 key+json字符串+key 进行md5 加密,如果是一致说明数据未被篡改。

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
appid 1676056269929 是 应用ID
sign 123718923789173121 是 签名

Body

名称类型是否必须默认值备注其他信息
keystring必须卡密编号,参数说明:卡密+验证码+旧激活码(非必填,续期使用),例如:111111x|asb22222x|asb33333(通过 x|asb 分割)

返回数据

名称类型是否必须默认值备注其他信息
codestring必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedstring必须业务是否请求成功,成功-true 失败-false
dataobject必须返回数据
├─ datastring必须激活码
├─ signstring必须签名信息,使用data进行签名,然后比对是否一致,一致说明数据未被篡改

域名授权检测V3接口(需要验签)

基本信息

Path: /auth/v3/auth

Method: POST

接口描述:

签名方式请看WIKI
注意:验签是使用返回的 data 中的 data 数据进行 key+json字符串+key 进行md5 加密,如果是一致说明数据未被篡改。

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
appid 1676056269929 是 应用ID
sign 123718923789173121 是 签名

Body

名称类型是否必须默认值备注其他信息
authNostring必须授权编号
domainNamestring必须域名地址

返回数据

名称类型是否必须默认值备注其他信息
codestring必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedstring必须业务是否请求成功,成功-true 失败-false
dataobject必须返回数据
├─ resultboolean必须是否验证通过
├─ signstring必须签名信息,使用data进行签名,然后比对是否一致,一致说明数据未被篡改

服务监测V3接口

基本信息

Path: /auth/v3/server

Method: POST

接口描述:

签名方式请看WIKI
注意:本接口无参数返回

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
appid 1676056269929 是 应用ID
sign 123718923789173121 是 签名

Body

名称类型是否必须默认值备注其他信息
entryNostring必须项目编号
accessAddressstring必须访问地址
authStatusinteger必须授权状态

返回数据

名称类型是否必须默认值备注其他信息
string非必须

查询授权信息V3接口

基本信息

Path: /auth/v3/pay_1763435063783

Method: POST

接口描述:

注意:头部需要携带登录成功后返回的token凭证

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
appid 1676056269929 是 应用ID
sign 123718923789173121 是 签名
token 123123213131111 是 鉴权Token,登录成功后返回的

Body

名称类型是否必须默认值备注其他信息
outTradeNostring必须订单号

返回数据

名称类型是否必须默认值备注其他信息
codestring必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedstring必须业务是否请求成功,成功-true 失败-false
datastring必须激活码

获取商品列表V3接口

基本信息

Path: /auth/v3/goodList

Method: POST

接口描述:

注意:头部需要携带登录成功后返回的token凭证

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
appid 1676056269929 是 应用ID
sign 123718923789173121 是 签名
token 123123213131111 是 鉴权Token,登录成功后返回的

Body

名称类型是否必须默认值备注其他信息
entryIdstring必须项目ID

返回数据

名称类型是否必须默认值备注其他信息
codestring必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedstring必须业务是否请求成功,成功-true 失败-false
dataobject []必须返回数据

item 类型: object

├─ idstring必须商品ID
├─ goodNamestring必须商品名称
├─ authTypestring必须授权类型(1-天 2-周 3-月 4-季 5-年)
├─ effectiveTimestring必须授权时长
├─ pricestring必须商品价格

获取最新版本V3接口(返回下一个版本)

基本信息

Path: /auth/v3/version

Method: POST

接口描述:

签名方式请看WIKI
注意:验签是使用返回的 data 中的 data 数据进行 key+json字符串+key 进行md5 加密,如果是一致说明数据未被篡改。

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
appid 1676056269929 是 应用ID
sign 123718923789173121 是 签名

Body

名称类型是否必须默认值备注其他信息
entryNostring必须项目编号
versionstring必须当前版本号

返回数据

名称类型是否必须默认值备注其他信息
codestring必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedstring必须业务是否请求成功,成功-true 失败-false
dataobject必须返回数据
├─ dataobject必须版本数据
├─ versionNumberstring必须当前版本
├─ updateUrlstring必须更新地址
├─ versionDescribestring必须版本描述
├─ extraParamstring必须额外参数
├─ createTimestring必须创建时间
├─ signstring必须签名信息,使用data进行签名,然后比对是否一致,一致说明数据未被篡改

获取项目列表V3接口

基本信息

Path: /auth/v3/entryList

Method: POST

接口描述:

注意:头部需要携带登录成功后返回的token凭证

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
appid 1676056269929 是 应用ID
sign 123718923789173121 是 签名
token 123123213131111 是 鉴权Token,登录成功后返回的

Body

名称类型是否必须默认值备注其他信息

返回数据

名称类型是否必须默认值备注其他信息
codestring必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedstring必须业务是否请求成功,成功-true 失败-false
dataobject []必须返回数据

item 类型: object

├─ idstring必须项目ID
├─ entryNamestring必须项目名称
├─ remarkstring必须备注

获取验证码V3接口

基本信息

Path: /auth/v3/vcode

Method: POST

接口描述:

签名方式请看WIKI
注意:验签是使用返回的 data 中的 data 数据进行 key+json字符串+key 进行md5 加密,如果是一致说明数据未被篡改。

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
appid 1676056269929 是 应用ID
sign 123718923789173121 是 签名

Body

名称类型是否必须默认值备注其他信息
typenumber必须验证码类型,1-短信验证码,2-邮箱验证码
phonestring必须手机号(类型1时必填)
emailstring必须邮箱(类型2时必填)

返回数据

名称类型是否必须默认值备注其他信息
codestring必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedstring必须业务是否请求成功,成功-true 失败-false

账号登录V3接口(需要验签)

基本信息

Path: /auth/v3/login

Method: POST

接口描述:

签名方式请看WIKI
注意:验签是使用返回的 data 中的 token 数据进行 key+json字符串+key 进行md5 加密,如果是一致说明数据未被篡改。

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
appid 1676056269929 是 应用ID
sign 123718923789173121 是 签名

Body

名称类型是否必须默认值备注其他信息
typestring必须验证码类型 1-短信验证码 2-邮箱验证码
usernamestring必须手机号/邮箱
codestring必须验证码

返回数据

名称类型是否必须默认值备注其他信息
codestring必须状态码,成功-200 失败-500
messagestring必须信息描述,包括错误信息描述
isSucceedstring必须业务是否请求成功,成功-true 失败-false
dataobject必须返回数据
├─ tokenstring必须token,部分接口请求头部需要携带
├─ signstring必须签名信息,使用data进行签名,然后比对是否一致,一致说明数据未被篡改

Build by YMFE.