API文档

更新时间：2025-04-25 17:26:00

日期	版本	修订内容摘要
2023-08-18	v2.0.0	更新接口文档

接口说明

API接口适用于不通过创蓝渠道发送短信客户，或者有特殊定制服务的客户。

API接口调用属于收费项目，具体收费详情请联系相关客户经理。

深链针对客户提供API创建接口

（1）支持短链链接，创建1号1链

（2）支持通知短信，长链转短链服务

（3）创建的短链可用于任意检测服务，如：微博、微信、公众号、网站等

（4）获取AppId和AppKey

预览

深链API接口计费服务

API接口采用会员制模式，开通短链会员即可调用API。

创建一号一链（一号一链有效期为30天，无数量限制）

一号一链

接口地址 https://slapi.chuanglan.com/prod/url/trace

请求方式 POST

consumes ["application/json"]

produces ["/"]

接口描述 30天有效期，不支持点击数据统计

HEAD请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
aid	智能短链平台API页面的APPID	head	true	string
sign	sign= MD5.getMd5(aid + appKey + body + timestamp) aid：深链API页面的APPID appKey：深链API页面的appKey body：请求的数据包JSON timestamp：时间戳	head	true	string
timestamp	时间戳	head	true	string
Content-Type	application/json

签名生成示例

复制成功
Map<String, Object> parammap = new HashMap<>();
parammap.put("url","a3xx.cc/v-UMxxU");
parammap.put("phone","15673494722");
parammap.put("batch","00999999999999991");
String s = JSONUtil.toJsonStr(parammap);
String checkSign = DigestUtil.md5Hex("65939497874632704" +
        "c1694936e58549b1bf8c8da36637b89f" + s + "1671096829626");
![](https://static2.253.com/document/2023-07/4X8JQAJUQXIEAL9F.png)

Body请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
batch	批次号	body	true	string
phone	手机号码（多个号码以逗号间隔）	body	true	string
url	url	body	true	string
domain	自定义域名	body	false

请求示例

复制成功
{
    "endDate":"2022-07-29",
    "shortUrl":"52.cn/v-6kp44",
    "startDate":"2022-07-28",
    "status":"0"
}

预览

响应参数

参数名称	参数说明	类型
code	状态码	string
data	返回数据	object
message	描述信息	string
success	是否成功	boolean

响应示例

复制成功
{
    "code": "",
    "data": {},
    "message": "",
    "success": true
}

响应状态

状态码	说明	描述
200	OK	API响应结果«Map«string,string»»
201	Created	创建成功
401	Unauthorized	验证错误
403	Forbidden	禁止创建
404	Not Found	未找到

单条长链接转短链接

接口地址 https://slapi.chuanglan.com/prod/url/short

请求方式 POST

consumes ["application/x-www-form-urlencoded"]

produces ["/"]

接口描述 30天有效期，不支持点击数据统计

HEAD请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
aid	智能短链平台API页面的APPID	head	true	string
sign	sign= MD5.getMd5(aid + appKey + body + timestamp) aid：深链API页面的APPID appKey：深链API页面的appKey body：请求的数据包JSON timestamp：时间戳	head	true	string
timestamp	时间戳	head	true	string
Content-Type	application/x-www-form-urlencoded

请求头示例

预览

Query参数

参数名称	参数说明	请求类型	是否必须	数据类型
url	url	query	true	string
domain	自定义域名	query	false	string

请求体示例

预览

响应参数

参数名称	参数说明	类型
code	状态码	string
data	返回数据	object
message	描述信息	string
success	是否成功	boolean

响应示例

复制成功
{
  "success": true,
  "code": "000000",
  "message": "成功",
  "data": {
    "shortUrl": "http://172.16.41.121:8082/sbQaQrm"
  }
}

响应状态

状态码	说明	描述
200	OK	API响应结果«Map«string,string»»
201	Created	创建成功
401	Unauthorized	验证错误
403	Forbidden	禁止创建
404	Not Found	未找到

注意：postman调用时，会将oldUrl中的/转义成%2F，代码中调用无需转义

生成签名sign示例

复制成功
String data = "url=http://baidu.com&domain=a3h.cc";
String checkSign = MD5.getMd5("123123123123" +
        "c1694936e58549b1bf8c8da388888888" + data + "1671096829626");

# 批量长链接转短链接

**接口地址** https://slapi.chuanglan.com/prod/url/batch_short
  
**请求方式** POST
  
**consumes** ["application/json"]

**produces** ["*/*"]

**接口描述** 30天有效期，一次请求最多传入100个长链，长链与短链顺序对应，不支持点击数据统计

## HEAD请求参数

| **参数名称** | **参数说明**                                                 | **请求类型** | **是否必须** | **数据类型** |
| ------------ | ------------------------------------------------------------ | ------------ | ------------ | ------------ |
| aid          | 智能短链平台API页面的APPID                                   | head         | true         | string       |
| sign         | sign= MD5.getMd5(aid + appKey + body + timestamp)<br />aid：深链API页面的APPID<br />appKey：深链API页面的appKey<br />body：请求的数据包JSON  <br />timestamp： 时间戳 | head         | true         | string       |
| timestamp    | 时间戳                                                       | head         | true         | string       |
| Content-Type | [application/json](https://blog.csdn.net/qq_14869093/article/details/86307084#applicationjson_42) |              |              |              |

## Body请求参数

| **参数名称** | **参数说明**           | **请求类型** | **是否必须** | **数据类型** |
| ------------ | ---------------------- | ------------ | ------------ | ------------ |
| batchId      | 批次号                 | body         | false        | string       |
| urlsdomain   | 链接地址数组自定义域名 | bodyquery    | truefalse    | arraystring  |
| domain       | 自定义域名             | body         | false        | string       |

**请求示例**

```java
{
    "batchId": "",
    "domain": "",
    "urls": ["www.baidu.com", "www.baidu2.com"]
}

响应参数

参数名称	参数说明	类型
code	状态码	string
datadata	返回数据返回数据
`shortUrl`	短链接描述信息	array
message	描述信息是否成功	string
success	是否成功	boolean

响应示例

复制成功
{
    "success": true,
    "code": "000000",
    "message": "成功",
    "data": {
      "shortUrl": [
            "172.16.41.121:8082/JmGincJ",
            "172.16.41.121:8082/JmHImR2",
            "172.16.41.121:8082/JmHImR3",
            "172.16.41.121:8082/JmHZXZ6",
            "172.16.41.121:8082/JmHZXZ7",
            "172.16.41.121:8082/JmHZXZ8"
        ]
            }
    ]
}

响应状态

状态码	说明	描述
200	OK	API响应结果«Map«string,string»»
201	Created	创建成功
401	Unauthorized	验证错误
403	Forbidden	禁止创建
404	Not Found	未找到

创建追踪短链/深链

接口地址 https://slapi.chuanglan.com/prod/url/short_trace

请求方式 POST

consumes ["application/json"]

produces ["/"]

接口描述 带v-的母链，有数量限制，永久100条，临时5000条/天，建议尽量使用临时的追踪短链

HEAD请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
aid	智能短链平台API页面的APPID	head	true	string
sign	sign= MD5.getMd5(aid + appKey + body + timestamp) aid：深链API页面的APPID appKey：深链API页面的appKey body：请求的数据包JSON timestamp：时间戳	head	true	string
timestamp	时间戳	head	true	string
Content-Type	application/json

Body请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
name	短链名称	body	true	string
url	跳转链接	body	true	string
domain	自定义域名	body	false	string
miniPath	路径或商品编号	body	false	string
type	功能类型 0 普通短链 1 小程序，2，小商店 ,3,APP	body	true	integer
miniAppId	小程序的APPID	body	type为1和2的时候必填	string
expiredType	过期类型 0 永久 1 自定义	body	false(默认0)	integer
expiredTime	过期时间	body	type为1时，必填 (示例:2023-01-03)	string
iosUrl	如果为小程序，小商店，APP 未安装时,IOS 默认跳转地址	body	false	string
androidUrl	如果为小程序，小商店，APP 未安装时,android 默认跳转地址	body	false	string
tlDeeplinkChannelConfigList	渠道配置	body	false	array
url	跳转链接	body	true	string
area	区域：省	body	false(不填为不限)	array(int)
sysOS	操作系统：WINDOS,IOS,Andriod等	body	false(不填为不限)	array(int)
accessSource	访问来源微信，QQ等	body	false	integer
status	0.关闭；1.开启	body	默认1:开启	integer
proportion	占比	body	skipType为2时必填	integer（1-100）
skipType	渠道跳转方式，1.正常跳 2.比例跳 3.随机跳	body	false	integer
preventBlock	防封锁 0 关闭 1 开启	body	false，默认关闭	integer

请求示例

复制成功
{
        "iosUrl": "https://www.baidu.com",
        "androidUrl": "https://www.baidu.com",
        "domain": "agxx.cn",
        "expiredType": 0,
        "miniAppId": "wx06582xxxf92db5ad",
        "name": "测试创建",
        "preventBlock": 0,
        "skipType": 1,
        "tlDeeplinkChannelConfigList": [
                {
                        "accessSource": 0,
                        "area": [1,2,3],
                        "status": 1,
                        "sysOS": [2],
                        "url": "http://www.taobao.com"
                },
                {
                        "accessSource": 0,
                        "area": [1,2,3],
                        "status": 1,
                        "sysOS": [2],
                        "url": "http://www.taobao.com"
                }
        ],
        "type": 1,
        "url": "http://www.tieba.com"
}

area数据

ID	area	ID	area	ID	area
1	北京	2	天津	3	河北
4	山西	5	内蒙古	6	辽宁
7	吉林	8	黑龙江	9	上海
10	江苏	11	浙江	12	安徽
13	福建	14	江西	15	山东
16	河南	17	湖北	18	湖南
19	广东	20	广西	21	海南
22	重庆	23	四川	24	贵州
25	云南	26	西藏	27	陕西
28	甘肃	29	青海	30	宁夏
31	新疆	32	香港	33	澳门
34	台湾

sysOS数据

ID	system	ID	system	ID	system
1	安卓	2	iPhone	3	Mac
4	Mac	5	鸿蒙

accessSource数据

ID	resource	ID	resource	ID	resource	ID	resource
0	不限	3	QQ	4	微信	-1	其他

响应参数

参数名称	参数说明	类型
code	状态码	string
data	返回数据
`id`		string
`url`	短链接	string
message	描述信息	string
success	是否成功	boolean

响应示例

复制成功
{
  "success": true,
  "message": "创建成功",
  "code": "000000",
  "data": {
    "id": "15840687811211264",
    "url": "aglc.cn/v-TOzZK"
  }
}

响应状态

状态码	说明	描述
200	OK	API响应结果«Map«string,string»»
201	Created	创建成功
401	Unauthorized	验证错误
403	Forbidden	禁止创建
404	Not Found	未找到
000800		永久短链超过100条
000801		当天临时短链创建超过5000条
000900		未初始化客户信息

数据统计

访问曲线

接口地址 https://slapi.chuanglan.com/dplink/queryAccessCurve

请求方式 POST

consumes ["application/json"]

produces ["/"]

接口描述 ``

HEAD请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
aid	智能短链平台API页面的APPID	head	true	string
sign	sign= MD5.getMd5(aid + appKey + body + timestamp) aid：深链API页面的APPID appKey：深链API页面的appKey body：请求的数据包JSON timestamp：时间戳	head	true	string
timestamp	时间戳	head	true	string

Body请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
endDate	结束时间批次号	body	false	string
shortUrl	链接地址	body	true	string
startDate	开始时间自定义域名	body	false	string
status	0:仅有效访问	body	false	string

请求示例

复制成功
{
    "endDate":"2022-07-29",
    "shortUrl":"52.cn/v-6kp44",
    "startDate":"2022-07-28",
    "status":"0"
}

响应参数

参数名称	参数说明	类型	schema
code		string
data		访问总曲线	访问总曲线
accessCurveVoList	访问量明细	array	访问曲线
browseCountVo	访问量	访问量	访问量
clickCount	访问点击量	integer
ipCount	访问IP数	integer
phoneCount	访问手机数	integer
uvCount	uv	integer
date	访问日期	string
totalList	总访问量	array	访问总量
name	访问名称	string
value	总访问量	integer
message		string
success		boolean

响应示例

复制成功
    "success":true,
    "message":"请求成功",
    "code":"000000",
    "data":{
        "totalList":[
            {
                "name":"访问量",
                "value":0
            },
            {
                "name":"访问手机数",
                "value":0
            },
            {
                "name":"访问ip数",
                "value":0
            },
            {
                "name":"访问uv数",
                "value":0
            }
        ],
        "accessCurveVoList":[
            {
                "date":"28日",
                "browseCountVo":{
                    "clickCount":0,
                    "phoneCount":0,
                    "ipCount":0,
                    "uvCount":0
                }
            },
            {
                "date":"29日",
                "browseCountVo":{
                    "clickCount":0,
                    "phoneCount":0,
                    "ipCount":0,
                    "uvCount":0
                }
            }
        ]
    }
}

响应状态

状态码	说明	描述
200	OK	API响应结果«Map«string,string»»
201	Created	创建成功
401	Unauthorized	验证错误
403	Forbidden	禁止创建
404	Not Found	未找到

归属地

接口地址 https://slapi.chuanglan.com/dplink/queryIpAddress

请求方式 POST

consumes ["application/json"]

produces ["/"]

接口描述 ``

HEAD请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
aid	智能短链平台API页面的APPID	head	true	string
sign	sign= MD5.getMd5(aid + appKey + body + timestamp) aid：深链API页面的APPID appKey：深链API页面的appKey body：请求的数据包JSON timestamp：时间戳	head	true	string
timestamp	时间戳	head	true	string

Body请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
endDate	结束时间批次号	body	false	string
shortUrl	链接地址	body	true	string
startDate	开始时间自定义域名	body	false	string
status	0:仅有效访问	body	false	string

请求示例

复制成功
{
    "endDate":"2022-07-29",
    "shortUrl":"52.cn/v-6kp44",
    "startDate":"2022-07-28",
    "status":"0"
}

响应参数

参数名称	参数说明	类型	schema
code		string
data		array	IP归属地
area	区	string
city	市	string
count	数量	integer
percentage	百分比	string
province	省	string
totalCount	数量	integer
message		string
success		boolean

响应示例

复制成功
{
    "success":true,
    "message":"请求成功",
    "code":"000000",
    "data":[
        {
            "province":"上海市",
            "city":null,
            "area":null,
            "percentage":"0.00%",
            "count":0,
            "totalCount":null
        },
        {
            "province":"云南省",
            "city":null,
            "area":null,
            "percentage":"0.00%",
            "count":0,
            "totalCount":null
        }
    ]
}

响应状态

状态码	说明	描述
200	OK	API响应结果«Map«string,string»»
201	Created	创建成功
401	Unauthorized	验证错误
403	Forbidden	禁止创建
404	Not Found	未找到

操作系统

接口地址 https://slapi.chuanglan.com/dplink/queryOperatingSystem

请求方式 POST

consumes ["application/json"]

produces ["/"]

接口描述 ``

HEAD请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
aid	智能短链平台API页面的APPID	head	true	string
sign	sign= MD5.getMd5(aid + appKey + body + timestamp) aid：深链API页面的APPID appKey：深链API页面的appKey body：请求的数据包JSON timestamp：时间戳	head	true	string
timestamp	时间戳	head	true	string

Body请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
endDate	结束时间批次号	body	false	string
shortUrl	链接地址	body	true	string
startDate	开始时间自定义域名	body	false	string
status	0:仅有效访问	body	false	string

请求示例

复制成功
{
    "endDate":"2022-07-29",
    "shortUrl":"52.cn/v-6kp44",
    "startDate":"2022-07-28",
    "status":"0"
}

响应参数

参数名称	参数说明	类型	schema
code		string
data		array	操作系统
count	数量	integer
logo	logo图标	string
percentage	百分比	string
systemName	系统名称	string
totalCount	总量	integer
message		string
success		boolean

响应示例

复制成功
{
    "success":true,
    "message":"请求成功",
    "code":"000000",
    "data":[
        {
            "logo":null,
            "systemName":"Android",
            "percentage":"0.00%",
            "count":0,
            "totalCount":0
        },
        {
            "logo":null,
            "systemName":"MacOS",
            "percentage":"0.00%",
            "count":0,
            "totalCount":0
        },
        {
            "logo":null,
            "systemName":"Windows",
            "percentage":"0.00%",
            "count":0,
            "totalCount":0
        },
        {
            "logo":null,
            "systemName":"iOS",
            "percentage":"0.00%",
            "count":0,
            "totalCount":0
        },
        {
            "logo":null,
            "systemName":"other",
            "percentage":"0.00%",
            "count":0,
            "totalCount":0
        }
    ]
}

响应状态

状态码	说明	描述
200	OK	API响应结果«Map«string,string»»
201	Created	创建成功
401	Unauthorized	验证错误
403	Forbidden	禁止创建
404	Not Found	未找到

浏览器

接口地址 https://slapi.chuanglan.com/dplink/queryBrowser

请求方式 POST

consumes ["application/json"]

produces ["/"]

接口描述 ``

HEAD请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
aid	智能短链平台API页面的APPID	head	true	string
sign	sign= MD5.getMd5(aid + appKey + body + timestamp) aid：深链API页面的APPID appKey：深链API页面的appKey body：请求的数据包JSON timestamp：时间戳	head	true	string
timestamp	时间戳	head	true	string

Body请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
endDate	结束时间批次号	body	false	string
shortUrl	链接地址	body	true	string
startDate	开始时间自定义域名	body	false	string
status	0:仅有效访问	body	false	string

请求示例

复制成功
{
    "endDate":"2022-07-29",
    "shortUrl":"52.cn/v-6kp44",
    "startDate":"2022-07-28",
    "status":"0"
}

响应参数

参数名称	参数说明	类型	schema
code		string
data		array	浏览器
count	数量	integer
logo	logo图标	string
percentage	百分比	string
systemName	浏览器名称	string
totalCount	数量	integer
message		string
success		boolean

响应示例

复制成功
{
    "success":true,
    "message":"请求成功",
    "code":"000000",
    "data":[
        {
            "logo":null,
            "systemName":"Chrome",
            "percentage":"0.00%",
            "count":0,
            "totalCount":0
        },
        {
            "logo":null,
            "systemName":"Firefox",
            "percentage":"0.00%",
            "count":0,
            "totalCount":0
        },
        {
            "logo":null,
            "systemName":"QQ浏览器",
            "percentage":"0.00%",
            "count":0,
            "totalCount":0
        },
        {    
            "logo":null,
            "systemName":"ie浏览器",
            "percentage":"0.00%",
            "count":0,
            "totalCount":0
        },
        {
            "logo":null,
            "systemName":"uc浏览器",
            "percentage":"0.00%",
            "count":0,
            "totalCount":0
        },
        {
            "logo":null,
            "systemName":"百度浏览器",
            "percentage":"0.00%",
            "count":0,
            "totalCount":0
        }
    ]
}

响应状态

状态码	说明	描述
200	OK	API响应结果«Map«string,string»»
201	Created	创建成功
401	Unauthorized	验证错误
403	Forbidden	禁止创建
404	Not Found	未找到

运营商

没有更多了

上一篇：操作指南

下一篇：常见问题

文档目录

收缩

热门搜索

中国站

国际站

API文档

接口说明

深链针对客户提供API创建接口

深链API接口计费服务

创建一号一链（一号一链有效期为30天，无数量限制）

一号一链

HEAD请求参数

Body请求参数

响应参数

单条长链接转短链接

HEAD请求参数

Query参数

响应参数

响应参数

创建追踪短链/深链

HEAD请求参数

Body请求参数

响应参数

数据统计

访问曲线

HEAD请求参数

Body请求参数

响应参数

归属地

HEAD请求参数

Body请求参数

响应参数

操作系统

HEAD请求参数

Body请求参数

响应参数

浏览器

HEAD请求参数

Body请求参数

响应参数

运营商