简单说明

此项目重新调整了代码结构及框架,具体请参考:kkapi-doc

接口 Base 域名:https://kkapi.vercel.app/当然你也可以部署到自己的 vercel 中绑定自己的域名。该项目开源仓库:api-vercel

所有的接口无特殊声明均支持 GET、POST 两种请求。

普通类型接口

此类接口地址全部为/index,通过参数type区分行为

获取文件内容

此接口会返回一个允许任何域的文件。

参数名称含义
type【必填】操作的类型cros
url【必填】请求文件的地址README.md

示例:https://kkapi.vercel.app/index?type=cros&url=https://raw.githubusercontent.com/DreamyTZK/DreamyTZK/master/README.md

返回 qq 头像

此接口返回 qq 头像

参数名称含义
type【必填】操作的类型qlogo
qq【必填】需要获取的 qq 号2045105376

调用示例:https://kkapi.vercel.app/index?type=qlogo&qq=2045105376

必应壁纸

此接口重定向到指定日期的必应壁纸,数据存储在 jsd

参数名称含义
type【必填】操作的类型bing
date【选填】需要获取的日期。
只能获取20200312及之后的图,之前的无法获取
20210101

调用示例:http://kkapi.vercel.app/index?type=bing&date=20210101

图片处理类

此接口可以处理一些图片,例如返回格式、宽度高度等。

参数名称含义
img【必填】图片地址cros
r【选填】图片旋转角度45
w【选填】设置图片的宽度100
h【选填】设置图片的高度100
fit【选填】设置图片填充方式,可选值:covercontainfillinsideoutsidecover
bg【选填】背景颜色#000
withoutEnlargement【选填】如果宽度或高度已经小于指定的尺寸,不要放大,默认falsefalse
format【选填】格式化图片,jpegpngwebptiffheifrawtilewebp
pos【选填】定位center
q【选填】输出图片的质量,取值为 1-100100

调用示例:https://kkapi.vercel.app/image?img=https://cdn.jsdelivr.net/gh/DreamyTZK/xiaokang.me@master/www/assets/bg/003.jpg&fit=outside&w=1440&h=900&format=webp

消息发送类

用于快捷的发送一些消息

发送电报消息

接口地址:/tegegram,参数

参数名称含义示例值
type【必填】操作类型,发送消息填写为send即可send
text【必填】消息内容小康
chat_id【必填】发送 tg 消息的对象,支持群组和个人。请先添加通知小助手否则 api 接口会调用失败。-1001289698078

调用示例:https://kkapi.vercel.app/telegram?type=send&text=test&chat_id=

企业微信通知

接口地址:/qywx,参数

参数名称含义示例值
type【必填】操作类型,发送普通文本使用text,markdown 使用markdowntext
id【必填】微信企业的 idww3dxxxxxxxxxxx76
secert【必填】企业应用的secertwYN1xxxLsbwod_eRexxxxxGLgFxxxxxD6b-xxxx
agentid【必填】企业应用 ID1000002
msg【必填】发送的消息1223
touser【必填】指定接收消息的成员,成员 ID 列表(多个接收者用‘|’分隔,最多支持 1000 个)。@all

调用示例:https://kkapi.vercel.app/api/qywx?type=text&id={企业 id}&secert={应用 secert}&agentid={应用 id}&msg={你要发的消息}&touser={发送给谁}

官方文档:https://work.weixin.qq.com/api/doc/90001/90143/90372

同类功能接口及教程:https://blog.zhheo.com/p/1e9f35bc.html

Github 相关的接口

此类接口地址全部为:/github,通过type区分操作类型。

触发 Actions

参数名称含义示例值
type【必填】操作类型dispatch
owner【必填】仓库主人用户名iServes
repo【必填】仓库名actions-friend-spider
token【必填】生成个人 Token,不会请参考项目中常用的密钥获取方式xxxxxxxx
runit_text【可选】触发 Actions 时的文本test