API: shorturl/group


概览


shorturl/group是 SUBMAIL 的短网址群组 API。

使用 shorturl/group API 可以获取、创建、编辑或删除您的短网址群组。

shorturl/group` API 使用 HTTP 规范中的 GET, POST, PUT, DELETE 方法对短网址群组进行操作,使用 GET 方法获取单个或全部短网址群组、POST 方法创建新的短网址群组、PUT 方法更新或编辑一个短网址群组,或使用 DELETE` 方法删除一个短网址群组。



URL


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


支持格式


格式URL
json https://service.mysubmail.com/shorturl/group.json(默认)
xmlhttps://service.mysubmail.com/shorturl/group.xml


http 请求方式


GET获取全部短网址,或获取指定的单个短网址
POST创建一个新的短网址
PUT编辑或更新一个短网址
DELETE删除一个短网址


是否需要授权


参阅 API 授权和验证机制


shorturl/group GET 方法(获取短网址群组)请求参数


参数类型必需/可选默认描述
appidstring必需在 SUBMAIL 应用集成中创建的短网址应用 ID
groupstring可选短网址群组ID
要获取单个短网址群组,请将在此参数中提交您要查询的具体群组id。为空则获取所有的短网址群组列表。
rowsint可选100单次返回数据的行数
请将该值控制在10-1000之间,若指定了一个无效的 rows 参数,API 将默认返回 100行数据
offsetint可选0数据偏移指针
该值可以指定返回数据的偏移指针,例:假如单次请求包含150条数据,rows参数采用50行,此时需要查询第51-100行的数据,请将 offset 参数设为1(即数据偏移50行)即可得到第51-100行的数据,offset=2时,将返回第101-150行数据,以此类推
timestampUNIX 时间戳可选参阅 API 授权与验证机制 > Timestamp UNIX 时间戳
sign_typestring可选normalAPI 授权模式( md5 or sha1 or normal
参阅 API 授权与验证机制 > 授权和验证方式
signaturestring必需应用密匙 数字签名
参阅 API 授权与验证机制 > 授权和验证方式


shorturl/group POST 方法(创建短链接群组)请求参数


参数类型必需/可选默认描述
appidstring必需在 SUBMAIL 应用集成中创建的短链接应用 ID
namestring必需短网址群组名称
timestampUNIX 时间戳可选参阅 API 授权与验证机制 > Timestamp UNIX 时间戳
sign_typestring可选normalAPI 授权模式( md5 or sha1 or normal
参阅 API 授权与验证机制 > 授权和验证方式
signaturestring必需应用密匙 数字签名
参阅 API 授权与验证机制 > 授权和验证方式


shorturl/group PUT 方法(更新短链接群组)请求参数


参数类型必需/可选默认描述
appidstring必需在 SUBMAIL 应用集成中创建的短网址的应用 ID
namestring必需短网址群组名称
groupstring必需要修改的短网址群组ID
timestampUNIX 时间戳可选参阅 API 授权与验证机制 > Timestamp UNIX 时间戳
sign_typestring可选normalAPI 授权模式( md5 or sha1 or normal
参阅 API 授权与验证机制 > 授权和验证方式
signaturestring必需应用密匙 数字签名
参阅 API 授权与验证机制 > 授权和验证方式


shorturl/group DELETE 方法(删除短链接群组)请求参数


参数类型必需/可选默认描述
appidstring必需在 SUBMAIL 应用集成中创建的短网址应用 ID
groupstring必需需要删除的目标短网址群组
timestampUNIX 时间戳可选参阅 API 授权与验证机制 > Timestamp UNIX 时间戳
sign_typestring可选normalAPI 授权模式( md5 or sha1 or normal
参阅 API 授权与验证机制 > 授权和验证方式
signaturestring必需应用密匙 数字签名
参阅 API 授权与验证机制 > 授权和验证方式


代码示例


使用 CURL GET方法获取短网址列表


发送 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方法提交短网址群组


发送 CURL
curl -d "appid=your_appid&signature=your_appkey&name=submail"。https://service.mysubmail.com/shorturl/group.json


返回
{
    "status": "success",
    "group": "3c6a3e194526c5dd4cd3378ad6a7b4"
}


使用 CURL PUT 方法修改短网址群组


发送 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 方法删除短网址群组


发送 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"
}


错误代码


参阅 API 错误代码