API接口
请求API必须携带token(请参见下面的示例),如果未发送token将出现错误,请确保对您的token保密以防止滥用。
使用以下两种方式均可
设置 authorization 头(推荐)
Authorization: token {YourToken}
或者在 POST 参数中添加 token
{token:{YourToken}}
短网址生成
生成短网址需要通过POST请求发送form表单,下面的示例显示了您可以发送的所有参数,但不需要发送所有参数。
参数 | 说明 |
---|---|
[url/urls] | (*) 要缩短的长网址 |
multiple | (可选) 如果是urls,此值请填入1 |
code | (可选) 自定义短网址后缀,批量生成无效 |
pass | (可选) 短网址访问密码 |
title | (可选) 网址备注 |
expire | (可选) 短网址有效期,日期格式:2025-05-05 |
API响应
默认响应JSON格式,“code”参数表示是否发生错误(code为0表示发生错误,code为200则正常),第二个参数“data”为返回的数据对象,根据第一个参数“code”的值发生变化,如果有错误则第二个参数被命名为“msg”,其中包含错误信息,否则将被命名为“data”,其中包含短网址。(请参见下面的示例)
{
"code" : 200,
"data": {
"array": false, // 是否为数组
"code": AA, // 如果是数组,则 code 变更为 codes
"short": https://s.028.gs/AA, // 如果是数组,则 short 变更为 shorts
}
}
错误处理
如果出现错误,请检查您的token是否正确,当“code”为“0”时,“msg”将显示错误提示。
{
"code" : 0,
"msg": "请输入正确的长网址"
}