授权对接文档

通过接口提交授权记录

接口状态

开发中

接口URL

http://localhost:8090/apis/lywqPluginAuth.muyin.site/v1alpha1/public/auth?pluginKey=linksSubmit&authDomain=blog.muyin.site&authUser=admin

请求方式

GET

Content-Type

none

请求Query参数

参数名	示例值	参数类型	是否必填	参数描述
pluginKey	linksSubmit	String	是	插件唯一标识
authDomain	blog.muyin.site	String	是	授权域名
authUser	admin	String	是	授权用户

成功响应示例

{
	"code": 200,
	"msg": "授权申请已发送，请等待审核！"
}

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码（200-成功；400-失败）
msg	授权申请已发送，请等待审核！	String	信息

错误响应示例

{
	"code": 400,
	"msg": "插件不存在！"
}

参数名	示例值	参数类型	参数描述
code	400	Integer	状态码（200-成功；400-失败）
msg	插件不存在！	String	信息

校验插件是否获得授权

接口状态

开发中

接口URL

http://localhost:8090/apis/lywqPluginAuth.muyin.site/v1alpha1/public/checkAuth?pluginKey=linksSubmit&authDomain=muyin.site

请求方式

GET

Content-Type

none

请求Query参数

参数名	示例值	参数类型	是否必填	参数描述
pluginKey	linksSubmit	String	是	插件唯一标识
authDomain	muyin.site	String	是	授权域名

成功响应示例

{
	"code": 200,
	"data": "8fc7e6b652f6f5f23699dfdf577325ab44671868c3ee5ebe847f8d4784854c3a6bb531d84700fca21d6ead5778247eb1df24bc45ae18d66a2c67d9e1692d08d2",
	"msg": "插件授权校验成功！"
}

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码（200-成功；400-失败）
data	8fc7e6b652f6f5f23699dfdf577325ab44671868c3ee5ebe847f8d4784854c3a6bb531d84700fca21d6ead5778247eb1df24bc45ae18d66a2c67d9e1692d08d2	String	返回数据（授权许可证）
msg	插件授权校验成功！	String	信息

错误响应示例

{
	"code": 400,
	"msg": "【linksSubmit】插件未授权！"
}

参数名	示例值	参数类型	参数描述
code	400	Integer	状态码（200-成功；400-失败）
msg	【linksSubmit】插件未授权！	String	信息

校验当前用户名是否已注册

接口状态

开发中

接口URL

http://localhost:8090/apis/lywqPluginAuth.muyin.site/v1alpha1/public/checkUser?authUser=admin

请求方式

GET

Content-Type

none

请求Query参数

参数名	示例值	参数类型	是否必填	参数描述
authUser	admin	String	是	授权用户

成功响应示例

{
	"code": 200,
	"msg": "用户存在！"
}

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码（200-成功；400-失败）
msg	用户存在！	String	信息

错误响应示例

{
	"code": 400,
	"msg": "用户不存在！"
}

参数名	示例值	参数类型	参数描述
code	400	Integer	状态码（200-成功；400-失败）
msg	用户不存在！	String	信息

获取指定插件的信息

接口状态

开发中

接口URL

http://localhost:8090/apis/lywqPluginAuth.muyin.site/v1alpha1/public/pluginInfo?pluginKey=linksSubmit

请求方式

GET

Content-Type

none

请求Query参数

参数名	示例值	参数类型	是否必填	参数描述
pluginKey	linksSubmit	String	是	插件唯一标识

成功响应示例

{
	"code": 200,
	"data": {
		"key": "linksSubmit",
		"name": "友链自助提交插件",
		"logo": "https://blog.muyin.site/upload/lywqPlugins/logo.png",
		"description": "只需一杯饮料（￥5）即可永久授权",
		"version": "1.3.2",
		"author": "lywq",
		"docs": "https://lywq.muyin.site/archives/29.html",
		"url": "https://lywq.muyin.site/archives/29.html",
		"price": "9999",
		"payUrl": "https://afdian.net/item/7b02c0ccf5aa11ee9a2a52540025c377"
	},
	"msg": "插件信息获取成功！"
}

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码（200-成功；400-失败）
data	-	Object	返回数据（插件信息）
data.key	linksSubmit	String	插件唯一标识
data.name	友链自助提交插件	String	插件名称
data.logo	https://blog.muyin.site/upload/lywqPlugins/logo.png	String	插件Logo
data.description	只需一杯饮料（￥5）即可永久授权	String	插件描述
data.version	1.3.2	String	插件版本
data.author	lywq	String	插件作者
data.docs	https://lywq.muyin.site/archives/29.html	String	插件文档
data.url	https://lywq.muyin.site/archives/29.html	String	插件地址
data.price	9999	String	插件售价（0.0为免费，9999为限时免费）
data.payUrl	https://afdian.net/item/7b02c0ccf5aa11ee9a2a52540025c377	String	付款地址
msg	插件信息获取成功！	String	信息

错误响应示例

{
	"code": 400,
	"msg": "插件不存在！"
}

参数名	示例值	参数类型	参数描述
code	400	Integer	状态码（200-成功；400-失败）
msg	插件不存在！	String	信息

根据插件唯一标识和授权域名获取授权用户名

接口状态

开发中

接口URL

http://localhost:8090/apis/lywqPluginAuth.muyin.site/v1alpha1/public/authUser?pluginKey=linksSubmit&authDomain=blog.muyin.site

请求方式

GET

Content-Type

none

请求Query参数

参数名	示例值	参数类型	是否必填	参数描述
pluginKey	linksSubmit	String	是	插件唯一标识
authDomain	blog.muyin.site	String	是	授权域名

成功响应示例

{
	"code": 200,
	"data": "admin",
	"msg": "查询到注册用户！"
}

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码（200-成功；400-失败）
data	admin	String	返回数据（授权用户名）
msg	查询到注册用户！	String	信息

错误响应示例

{
	"code": 400,
	"msg": "未查询到注册用户！"
}

参数名	示例值	参数类型	参数描述
code	400	Integer	状态码（200-成功；400-失败）
msg	未查询到注册用户！	String	信息

通过接口生成通用授权码

接口状态

开发中

接口URL

http://localhost:8090/apis/lywqPluginAuth.muyin.site/v1alpha1/public/generateAuthCode

请求方式

GET

Content-Type

none

成功响应示例

{
	"code": 200,
	"data": "40124836",
	"msg": "授权码生成成功，有效期为5分钟！"
}

参数名	示例值	参数类型	参数描述
code	200	Integer	状态码（200-成功；400-失败）
data	40124836	String	返回数据（授权码）
msg	授权码生成成功，有效期为5分钟！	String	信息