API: ShortURL/Group - 短網(wǎng)址群組
概覽
shorturl/group是 SUBMAIL 的短網(wǎng)址群組 API。
使用 shorturl/group API 可以獲取、創(chuàng)建、編輯或刪除您的短網(wǎng)址群組。
shorturl/group` API 使用 HTTP 規(guī)范中的 GET, POST, PUT, DELETE 方法對短網(wǎng)址群組進行操作,使用 GET 方法獲取單個或全部短網(wǎng)址群組、POST 方法創(chuàng)建新的短網(wǎng)址群組、PUT 方法更新或編輯一個短網(wǎng)址群組,或使用 DELETE` 方法刪除一個短網(wǎng)址群組。
URL
<主>https://service.mysubmail.com/shorturl/group
支持格式
| 格式 | URL |
|---|---|
json | https://service.mysubmail.com/shorturl/group.json(默認(rèn)) |
xml | https://service.mysubmail.com/shorturl/group.xml |
http 請求方式
GET | 獲取全部短網(wǎng)址,或獲取指定的單個短網(wǎng)址 |
|---|---|
POST | 創(chuàng)建一個新的短網(wǎng)址 |
PUT | 編輯或更新一個短網(wǎng)址 |
DELETE | 刪除一個短網(wǎng)址 |
是否需要授權(quán)
是
參閱 API 授權(quán)和驗證機制
shorturl/group GET 方法(獲取短網(wǎng)址群組)請求參數(shù)
| 參數(shù) | 類型 | 必需/可選 | 默認(rèn) | 描述 |
|---|---|---|---|---|
appid | string | 必需 | 無 | 在 SUBMAIL 應(yīng)用集成中創(chuàng)建的短網(wǎng)址應(yīng)用 ID |
rows | int | 可選 | 100 | 單次返回數(shù)據(jù)的行數(shù) 請將該值控制在10-1000之間,若指定了一個無效的 rows 參數(shù),API 將默認(rèn)返回 100行數(shù)據(jù) |
offset | int | 可選 | 0 | 數(shù)據(jù)偏移指針 該值可以指定返回數(shù)據(jù)的偏移指針,例:假如單次請求包含150條數(shù)據(jù),rows參數(shù)采用50行,此時需要查詢第51-100行的數(shù)據(jù),請將 offset 參數(shù)設(shè)為1(即數(shù)據(jù)偏移50行)即可得到第51-100行的數(shù)據(jù),offset=2時,將返回第101-150行數(shù)據(jù),以此類推 |
timestamp | UNIX 時間戳 | 可選 | 無 | 參閱 API 授權(quán)與驗證機制 > Timestamp UNIX 時間戳 |
sign_type | string | 可選 | normal | API 授權(quán)模式( md5 or sha1 or normal )參閱 API 授權(quán)與驗證機制 > 授權(quán)和驗證方式 |
signature | string | 必需 | 無 | 應(yīng)用密匙 或 數(shù)字簽名 參閱 API 授權(quán)與驗證機制 > 授權(quán)和驗證方式 |
shorturl/group POST 方法(創(chuàng)建短鏈接群組)請求參數(shù)
| 參數(shù) | 類型 | 必需/可選 | 默認(rèn) | 描述 |
|---|---|---|---|---|
appid | string | 必需 | 無 | 在 SUBMAIL 應(yīng)用集成中創(chuàng)建的短鏈接應(yīng)用 ID |
name | string | 必需 | 無 | 短網(wǎng)址群組名稱 |
timestamp | UNIX 時間戳 | 可選 | 無 | 參閱 API 授權(quán)與驗證機制 > Timestamp UNIX 時間戳 |
sign_type | string | 可選 | normal | API 授權(quán)模式( md5 or sha1 or normal )參閱 API 授權(quán)與驗證機制 > 授權(quán)和驗證方式 |
signature | string | 必需 | 無 | 應(yīng)用密匙 或 數(shù)字簽名 參閱 API 授權(quán)與驗證機制 > 授權(quán)和驗證方式 |
shorturl/group PUT 方法(更新短鏈接群組)請求參數(shù)
| 參數(shù) | 類型 | 必需/可選 | 默認(rèn) | 描述 |
|---|---|---|---|---|
appid | string | 必需 | 無 | 在 SUBMAIL 應(yīng)用集成中創(chuàng)建的短網(wǎng)址的應(yīng)用 ID |
name | string | 必需 | 無 | 短網(wǎng)址群組名稱 |
group | string | 必需 | 無 | 要修改的短網(wǎng)址群組ID |
timestamp | UNIX 時間戳 | 可選 | 無 | 參閱 API 授權(quán)與驗證機制 > Timestamp UNIX 時間戳 |
sign_type | string | 可選 | normal | API 授權(quán)模式( md5 or sha1 or normal )參閱 API 授權(quán)與驗證機制 > 授權(quán)和驗證方式 |
signature | string | 必需 | 無 | 應(yīng)用密匙 或 數(shù)字簽名 參閱 API 授權(quán)與驗證機制 > 授權(quán)和驗證方式 |
shorturl/group DELETE 方法(刪除短鏈接群組)請求參數(shù)
| 參數(shù) | 類型 | 必需/可選 | 默認(rèn) | 描述 |
|---|---|---|---|---|
appid | string | 必需 | 無 | 在 SUBMAIL 應(yīng)用集成中創(chuàng)建的短網(wǎng)址應(yīng)用 ID |
group | string | 必需 | 無 | 需要刪除的目標(biāo)短網(wǎng)址群組 |
timestamp | UNIX 時間戳 | 可選 | 無 | 參閱 API 授權(quán)與驗證機制 > Timestamp UNIX 時間戳 |
sign_type | string | 可選 | normal | API 授權(quán)模式( md5 or sha1 or normal )參閱 API 授權(quán)與驗證機制 > 授權(quán)和驗證方式 |
signature | string | 必需 | 無 | 應(yīng)用密匙 或 數(shù)字簽名 參閱 API 授權(quán)與驗證機制 > 授權(quán)和驗證方式 |
代碼示例
使用 CURL GET方法獲取短網(wǎng)址列表
發(fā)送 CURL
curl -s "https://service.mysubmail.com/shorturl/group.json?appid=your_appid&signature=your_appkey"返回
{
"status": "success",
"groups": [
{
"group": "09ae64b7adbfe917f58e5ddd5200915",
"name": "submailTest",
"create_at": "2019-07-17 07:24:28"
}
]
}使用 CURL POST方法提交短網(wǎng)址群組
發(fā)送 CURL
curl -d "appid=your_appid&signature=your_appkey&name=submail"。https://service.mysubmail.com/shorturl/group.json返回
{
"status": "success",
"group": "3c6a3e194526c5dd4cd3378ad6a7b4"
}使用 CURL PUT 方法修改短網(wǎng)址群組
發(fā)送 CURL
curl --data "appid=your_appid&signature=your_appkey&name=submailgroup=3c6a3e194526cdd4cd3378ad6a7b4" -X put https://service.mysubmail.com/shorturl/group.json返回
{
"status":"success"
}使用 CURL DELETE 方法刪除短網(wǎng)址群組
發(fā)送 CURL
curl --data "appid=your_appid&signature=your_appkey&group=3c6a3e194526cdd4cd3378ad6a7b4" -X delete https://service.mysubmail.com/shorturl/group.json返回
{
"status":"success"
}返回值
請求成功
{
"status":"success"
}請求失敗
{
"status":"error",
"code":"1xx",
"msg":"error message"
}