API：ShortURL - 短網(wǎng)址

概覽

Shorturl是 SUBMAIL 的短網(wǎng)址 API。

使用 Shorturl API 可以獲取、創(chuàng)建、編輯或刪除您的短網(wǎng)址。

shorturl API 使用 HTTP 規(guī)范中的 GET, POST, PUT, DELETE 方法對短網(wǎng)址進行操作，使用 GET 方法獲取單個或全部短網(wǎng)址、POST 方法創(chuàng)建新的短網(wǎng)址并提交至 SUBMAIL 人工審核、PUT 方法更新或編輯一個短網(wǎng)址，或使用 DELETE 方法刪除一個短網(wǎng)址。

短網(wǎng)址引擎支持 SUBHOOK 異步推送狀態(tài)，短網(wǎng)址在后臺人工審核后，會使用 SUBHOOK 進行主動推送狀態(tài)。

URL

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

支持格式

http 請求方式

是否需要授權

是

參閱 API 授權和驗證機制

ShortURl GET 方法（獲取短網(wǎng)址列表）請求參數(shù)

ShortURl POST 方法（創(chuàng)建短網(wǎng)址）請求參數(shù)

ShortURl PUT 方法（更新短鏈接）請求參數(shù)

ShortURL DELETE 方法（刪除短網(wǎng)址）請求參數(shù)

ShortURL Routes參數(shù)說明

routes參數(shù)json結構說明

routes

desktop ：可選參數(shù)。設置桌面端操作系統(tǒng)點擊跳轉的目標url，如果此參數(shù)不傳則跳轉到默認設置目標url。

windows ：可選參數(shù)。設置windows操作系統(tǒng)點擊跳轉的目標url，如果此參數(shù)不傳則跳轉到默認設置目標url。

mac ：可選參數(shù)。設置mac操作系統(tǒng)點擊跳轉的目標url，如果此參數(shù)不傳則跳轉到默認設置目標url。

linux ：可選參數(shù)。設置linux操作系統(tǒng)點擊跳轉目標url，如果此參數(shù)不傳則跳轉到默認設置目標url。

mobile:可選參數(shù)。設置移動端操作系統(tǒng)點擊跳轉目標url,如果此參數(shù)不傳則跳轉到默認設置目標url。

device:可選參數(shù)。如果此參數(shù)不傳則跳轉到默認設置目標url。

ios:可選參數(shù)。設置ios操作系統(tǒng)點擊跳轉目標url，如果此參數(shù)不傳則跳轉到默認設置目標url。

android:可選參數(shù)。設置android操作系統(tǒng)點擊跳轉目標url，如果此參數(shù)不傳則跳轉到默認設置目標url。

others:可選參數(shù)。設置除ios，android操作系統(tǒng)外點擊跳轉目標url，如果此參數(shù)不傳則跳轉到默認設置目標url。

app:可選參數(shù)。設置微信以及支付寶點擊跳轉目標url，如果此參數(shù)不傳則跳轉到對應手機操作系統(tǒng)設置的目標跳轉url。

wechat:可選參數(shù)。設置微信app內點擊跳轉目標url，如果此參數(shù)不傳則跳轉到對應手機操作系統(tǒng)設置的目標跳轉url。

alipay:可選參數(shù)。設置支付寶app內點擊跳轉目標url，如果此參數(shù)不傳則跳轉到對應手機操作系統(tǒng)設置的目標跳轉url。

robot:可選參數(shù)。設置機器人點擊跳轉目標地址，如果此參數(shù)不傳則跳轉到默認設置目標url。

routes參數(shù)json字符串示列

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

代碼示例

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

發(fā)送 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":"http://www.reatop.cn/windows","model":"url"},
                                "mac": {"url":"http://www.reatop.cn/mac","model":"url"},
                                "linux": {"url":"http://www.reatop.cn/linux","model":"url"},
                                "other": {"url":"http://www.reatop.cn/other","model":"url"}
                                },
                                "mobile": {
                                        "device": {
                                                "ios": {"url":"weixin://dl/business/?ticket=***","model":"url-scheme"},
                                                "android": {"url":"http://www.reatop.cn/android","model":"url"},
                                                "others": {"url":"http://www.reatop.cn/others","model":"url"}
                                        },
                                        "app": {
                                                "wechat":{"url":"http://www.reatop.cn/wechat","model":"url"},
                                                "alipay": {"url":"http://www.reatop.cn/alipay","model":"url"},
                                                "others": {"url":"http://www.reatop.cn/others","model":"url"}
                                        }
                                },
                                "robot": {"url":"http://www.reatop.cn/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": "http://www.reatop.cn/windows",
                "mac": "http://www.reatop.cn/mac",
                "linux": "http://www.reatop.cn/linux"
                         },
              "mobile": {
                "device": {
                  "ios": "http://www.reatop.cn/ios",
                  "android": "http://www.reatop.cn/android",
                  "others": "http://www.reatop.cn/others"
                        },
               "app": {
                 "wechat": "http://www.reatop.cn/chs/store",
                 "alipay": "http://www.reatop.cn/slinks"
                      }
                        },
              "robot": "http://www.reatop.cn/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方法提交短網(wǎng)址

發(fā)送 CURL

curl -d "appid=your_appid&signature=your_appkey&url=https://www.api.submail.cn&group=09ae645ddd5200915&item=test&routes={"desktop":{"windows":"http://www.reatop.cn/windows","mac":"http://www.reatop.cn/mac","linux":"http://www.reatop.cn/linux"},"mobile":{"device":{"ios":"http://www.reatop.cn/ios","android":"http://www.reatop.cn/android","others":"http://www.reatop.cn/others"},"app":{"wechat":"http://www.reatop.cn/wechat","alipay":"http://www.reatop.cn/alipay"}},"robot":"http://www.reatop.cn/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":"http://www.reatop.cn/windows","model":"url"},
            "mac": {"url":"http://www.reatop.cn/mac","model":"url"},
            "linux": {"url":"http://www.reatop.cn/linux","model":"url"},
                        "other": {"url":"http://www.reatop.cn/other","model":"url"}
        },
        "mobile": {
            "device": {
                "ios": {"url":"weixin://dl/business/?ticket=***","model":"url-scheme"},
                "android": {"url":"http://www.reatop.cn/android","model":"url"},
                "others": {"url":"http://www.reatop.cn/others","model":"url"}
            },
            "app": {
                "wechat":{"url":"http://www.reatop.cn/wechat","model":"url"},
                "alipay": {"url":"http://www.reatop.cn/alipay","model":"url"},
                                "others": {"url":"http://www.reatop.cn/others","model":"url"}
            }
        },
        "robot": {"url":"http://www.reatop.cn/robot","model":"url"}
    },
    "qrcode": "http://suburl.cn/qrcode?url=httxxxink.wiki/KSWfb5",
    "expire_at": "2021-04-01 16:33:42"
}

qrcode:為目標短網(wǎng)址生成的二維碼地址。

使用 CURL PUT 方法修改短網(wǎng)址

發(fā)送 CURL

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

返回

{
    "status":"success"
}

使用 CURL DELETE 方法刪除短網(wǎng)址

發(fā)送 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 短網(wǎng)址狀態(tài)描述

返回值

請求成功

{
      "status":"success"
}

請求失敗

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

錯誤代碼

參閱 API 錯誤代碼