API：ShortURL - 短网址

概览

Shorturl是 SUBMAIL 的短网址 API。

使用 Shorturl API 可以获取、创建、编辑或删除您的短网址。

shorturl API 使用 HTTP 规范中的 GET, POST, PUT, DELETE 方法对短网址进行操作，使用 GET 方法获取单个或全部短网址、POST 方法创建新的短网址并提交至 SUBMAIL 人工审核、PUT 方法更新或编辑一个短网址，或使用 DELETE 方法删除一个短网址。

短网址引擎支持 SUBHOOK 异步推送状态，短网址在后台人工审核后，会使用 SUBHOOK 进行主动推送状态。

URL

<主> https://service.mysubmail.com/shorturl

支持格式

http 请求方式

是否需要授权

是

参阅 API 授权和验证机制

ShortURl GET 方法（获取短网址列表）请求参数

ShortURl POST 方法（创建短网址）请求参数

ShortURl PUT 方法（更新短链接）请求参数

ShortURL DELETE 方法（删除短网址）请求参数

ShortURL Routes参数说明

routes参数json结构说明

routes

desktop ：可选参数。设置桌面端操作系统点击跳转的目标url，如果此参数不传则跳转到默认设置目标url。

windows ：可选参数。设置windows操作系统点击跳转的目标url，如果此参数不传则跳转到默认设置目标url。

mac ：可选参数。设置mac操作系统点击跳转的目标url，如果此参数不传则跳转到默认设置目标url。

linux ：可选参数。设置linux操作系统点击跳转目标url，如果此参数不传则跳转到默认设置目标url。

mobile:可选参数。设置移动端操作系统点击跳转目标url,如果此参数不传则跳转到默认设置目标url。

device:可选参数。如果此参数不传则跳转到默认设置目标url。

ios:可选参数。设置ios操作系统点击跳转目标url，如果此参数不传则跳转到默认设置目标url。

android:可选参数。设置android操作系统点击跳转目标url，如果此参数不传则跳转到默认设置目标url。

others:可选参数。设置除ios，android操作系统外点击跳转目标url，如果此参数不传则跳转到默认设置目标url。

app:可选参数。设置微信以及支付宝点击跳转目标url，如果此参数不传则跳转到对应手机操作系统设置的目标跳转url。

wechat:可选参数。设置微信app内点击跳转目标url，如果此参数不传则跳转到对应手机操作系统设置的目标跳转url。

alipay:可选参数。设置支付宝app内点击跳转目标url，如果此参数不传则跳转到对应手机操作系统设置的目标跳转url。

robot:可选参数。设置机器人点击跳转目标地址，如果此参数不传则跳转到默认设置目标url。

routes参数json字符串示列

{
        "desktop": {
            "windows": {"url":"https://www.mysubmail.com/windows","model":"url"},
            "mac": {"url":"https://www.mysubmail.com/mac","model":"url"},
            "linux": {"url":"https://www.mysubmail.com/linux","model":"url"},
        "other": {"url":"https://www.mysubmail.com/other","model":"url"}
        },
        "mobile": {
            "device": {
                "ios": {"url":"weixin://dl/business/?ticket=***","model":"url-scheme"},
                "android": {"url":"https://www.mysubmail.com/android","model":"url"},
                "others": {"url":"https://www.mysubmail.com/others","model":"url"}
            },
            "app": {
                "wechat":{"url":"https://www.mysubmail.com/wechat","model":"url"},
                "alipay": {"url":"https://www.mysubmail.com/alipay","model":"url"},
                "others": {"url":"https://www.mysubmail.com/others","model":"url"}
            }
        },
        "robot": {"url":"https://www.mysubmail.com/robot","model":"url"}
    }

代码示例

使用 CURL GET方法获取模板列表

发送 CURL

curl -s "https://service.mysubmail.com/shorturl?appid=your_appid&signature=your_appkey"

返回

{
    "status": "success",
    "urls": [
        {
            "short_url": "http://link.wiki/anPi5G",
            "long_url": "http://mysubmail.cn/developer",
            "items": "",
            "access_password": "0",
            "access_limit": "0",
            "pause": "false",
            "routes": {
                            "desktop": {
                            "windows": {"url":"https://www.mysubmail.com/windows","model":"url"},
                                "mac": {"url":"https://www.mysubmail.com/mac","model":"url"},
                                "linux": {"url":"https://www.mysubmail.com/linux","model":"url"},
                                "other": {"url":"https://www.mysubmail.com/other","model":"url"}
                                },
                                "mobile": {
                                        "device": {
                                                "ios": {"url":"weixin://dl/business/?ticket=***","model":"url-scheme"},
                                                "android": {"url":"https://www.mysubmail.com/android","model":"url"},
                                                "others": {"url":"https://www.mysubmail.com/others","model":"url"}
                                        },
                                        "app": {
                                                "wechat":{"url":"https://www.mysubmail.com/wechat","model":"url"},
                                                "alipay": {"url":"https://www.mysubmail.com/alipay","model":"url"},
                                                "others": {"url":"https://www.mysubmail.com/others","model":"url"}
                                        }
                                },
                                "robot": {"url":"https://www.mysubmail.com/robot","model":"url"}
                        },
            "qrcode": "http://suburl.cn/qrcode?url=httxxxink.wiki/KSWfb5",
            "tag": "test2",
            "create_at": "2019-07-17 10:28:11",
            "review_status": "2",
            "review_status_description": "通过审核",
            "expire_by_hours": "168",
            "expire_at": "2019-07-24 10:28:11"
        },
        {
            "short_url": "http://sw2.co/bTOCOG",
            "long_url": "http://www.baidu.com",
            "items": "",
            "access_password": "0",
            "access_limit": "0",
            "pause": "false",
             "routes": {
              "desktop": {
                "windows": "https://www.mysubmail.com/windows",
                "mac": "https://www.mysubmail.com/mac",
                "linux": "https://www.mysubmail.com/linux"
                         },
              "mobile": {
                "device": {
                  "ios": "https://www.mysubmail.com/ios",
                  "android": "https://www.mysubmail.com/android",
                  "others": "https://www.mysubmail.com/others"
                        },
               "app": {
                 "wechat": "https://www.mysubmail.com/chs/store",
                 "alipay": "https://www.mysubmail.com/slinks"
                      }
                        },
              "robot": "https://www.mysubmail.com/robot"
                      },
            "qrcode": "http://suburl.cn/qrcode?url=httxxxink.wiki/KSWfb5",
            "tag": "",
            "create_at": "2019-07-17 09:57:47",
            "review_status": "2",
            "review_status_description": "通过审核",
            "expire_by_hours": "168",
            "expire_at": "2019-07-24 09:57:47"
        }
    ]
}

使用 CURL POST方法提交短网址

发送 CURL

curl -d "appid=your_appid&signature=your_appkey&url=https://www.api.submail.cn&group=09ae645ddd5200915&item=test&routes={"desktop":{"windows":"https://www.mysubmail.com/windows","mac":"https://www.mysubmail.com/mac","linux":"https://www.mysubmail.com/linux"},"mobile":{"device":{"ios":"https://www.mysubmail.com/ios","android":"https://www.mysubmail.com/android","others":"https://www.mysubmail.com/others"},"app":{"wechat":"https://www.mysubmail.com/wechat","alipay":"https://www.mysubmail.com/alipay"}},"robot":"https://www.mysubmail.com/robot"}"。" https://service.mysubmail.com/shorturl.json

返回

{
    "status": "success",
    "short_url": "http://link.wiki/KSWfb5",
    "long_url": "https://blog.csdn.net/fdipzone/article/details/42463727/32132131、321///23123/32132133213",
    "routes": {
        "desktop": {
            "windows": {"url":"https://www.mysubmail.com/windows","model":"url"},
            "mac": {"url":"https://www.mysubmail.com/mac","model":"url"},
            "linux": {"url":"https://www.mysubmail.com/linux","model":"url"},
                        "other": {"url":"https://www.mysubmail.com/other","model":"url"}
        },
        "mobile": {
            "device": {
                "ios": {"url":"weixin://dl/business/?ticket=***","model":"url-scheme"},
                "android": {"url":"https://www.mysubmail.com/android","model":"url"},
                "others": {"url":"https://www.mysubmail.com/others","model":"url"}
            },
            "app": {
                "wechat":{"url":"https://www.mysubmail.com/wechat","model":"url"},
                "alipay": {"url":"https://www.mysubmail.com/alipay","model":"url"},
                                "others": {"url":"https://www.mysubmail.com/others","model":"url"}
            }
        },
        "robot": {"url":"https://www.mysubmail.com/robot","model":"url"}
    },
    "qrcode": "http://suburl.cn/qrcode?url=httxxxink.wiki/KSWfb5",
    "expire_at": "2021-04-01 16:33:42"
}

qrcode:为目标短网址生成的二维码地址。

使用 CURL PUT 方法修改短网址

发送 CURL

curl --data "appid=your_appid&signature=your_appkey&short_url=http://link.wiki/iM/GuvPeD&url=https://www.mysubmail.com&pause=true&item=submail&expire=100" -X put https://service.mysubmail.com/shorturl.json

返回

{
    "status":"success"
}

使用 CURL DELETE 方法删除短网址

发送 CURL

curl --data "appid=your_appid&signature=your_appkey&short_url=http://link.wiki/iM/GuvPeD" -X delete  https://service.mysubmail.com/shorturl.json

返回

{
    "status":"success"
}

review_status 短网址状态描述

返回值

请求成功

{
      "status":"success"
}

请求失败

{
      "status":"error",
      "code":"1xx",
      "msg":"error message"
}

错误代码

参阅 API 错误代码