短网址

接口说明

将指定的长链接缩短为便于分享的短链接，访问短链可直接跳转至原始地址，过程中无广告插入、无额外等待。生成的数据默认保存 30 天，期间短链每被访问一次，到期时间会自动顺延更新，适合需要长期投放或频繁分享链接的场景。请勿对违法违规网址进行缩短，否则本站有权将相关数据交由有关部门处理。

调用地址

https://xiaoapi.cn/v1/dwz_free.php

请求方式

支持 GET、POST 两种方式提交请求。

鉴权说明

本接口为公开免费接口，无需密钥，直接在请求中携带所需参数即可调用。

请求参数

调用地址：https://xiaoapi.cn/v1/dwz_free.php，请求方式支持 GET 与 POST。

参数取值说明：

• url：必须为可正常访问的完整网址，请勿提交违法违规网址。
• suol_type：任意非空值即视为存在，例如传 1 时只返回短链本身。

生成的数据保存 30 天，期间短链每被访问一次，到期时间自动更新。

成功响应示例

{
  "code": 200,
  "y_url": "http://xiaoapi.cn",
  "s_url": "http://suol.cc/ESzoA3",
  "tips": "慕名API：http://xiaoapi.cn"
}

若请求时传入了 suol_type，则仅返回短链本身，不含其他内容：

http://suol.cc/ESzoA3

响应字段说明

补充说明：

• 短链数据保存 30 天，期间该短链每被访问一次，到期时间会自动顺延更新。
• 当请求参数中包含 suol_type 时，响应体为纯文本短链，无 code、y_url、tips 字段。
• 本站对违法违规网址不予缩短，请确保传入的 url 合法合规。

错误响应示例

接口在参数缺失、参数格式不正确、接口维护、请求方式不被允许等情况下，会返回统一结构的 JSON 错误响应。响应体固定包含 code、msg、errcode 三个字段：code 为 0 表示本次调用未成功返回业务数据，msg 为可读的错误说明，errcode 为业务错误码，用于程序化判断具体失败原因。

{
  "code": 0,
  "msg": "未提供调用密钥",
  "errcode": 11001
}

缺少必填参数 url 时的错误响应示例：

{
  "code": 0,
  "msg": "缺少参数 url",
  "errcode": 11012
}

接口处于维护状态时的错误响应示例：

{
  "code": 0,
  "msg": "接口维护中",
  "errcode": 11006
}

请求方式不被允许时的错误响应示例：

{
  "code": 0,
  "msg": "请求方式不允许",
  "errcode": 11018
}

请求的接口路径不存在时的错误响应示例：

{
  "code": 0,
  "msg": "接口不存在",
  "errcode": 11013
}

业务错误码说明

下表列出本站接口可能返回的全部业务错误码及其含义。调用方可依据响应中的 errcode 字段进行判断与后续处理。

补充说明：

• 11005 为频率限制类错误，触发后请降低请求频率后重试。
• 11009、11010、11017 为暂时性服务异常，通常稍后重试即可恢复。
• 11013 至 11016 与 11017 同样适用于代理类接口，出现时表示目标地址无效、不被允许、请求失败或服务暂不可用。
• 11012 表示请求中携带的鉴权方式与本接口要求不符。
• 本接口无需密钥、免费调用，因此与密钥、积分相关的错误码通常不会在本接口出现，但在同一响应结构下仍可能由整站统一返回。

调用示例

终端 curl（bash）

curl -G 'https://xiaoapi.cn/v1/dwz_free.php' \
  --data-urlencode 'url=https://xiaoapi.cn/'

PHP

// PHP 示例
$api = 'https://xiaoapi.cn/v1/dwz_free.php?' . http_build_query([
    'url' => 'https://xiaoapi.cn/',
]);

$ch = curl_init($api);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);

echo $response;

注意事项

• 链接合规性：请勿对违法违规网址进行缩短。对违规网址提交者，本站有权将相关数据交由有关部门处理，由此产生的责任由调用方自行承担。
• 有效期与刷新机制：生成的数据保存 30 天，期间短链每次被访问会自动更新到期时间；若 30 天内无任何访问，短链将失效，请勿将其用于长期固定投放场景。
• 参数取值：url 为必填项，须传入带完整协议头的网址（如 https://xiaoapi.cn/），不要传入裸域名或相对路径；传入前建议自行做一次转义或编码，避免参数中的 &、? 等字符截断请求。
• 返回差异：suol_type 仅在需要纯短链结果的场景下传入；不传该参数时会返回完整结构（含状态码、原链、短链与提示信息），请按对应格式解析，不要假定响应中始终存在 s_url 以外的字段。
• 传输安全：请通过 https://xiaoapi.cn/v1/dwz_free.php 以 HTTPS 调用，避免链接在明文链路中泄露；同时不要在浏览器前端或公开的页面脚本中拼接、暴露调用细节。
• 请求方式：GET 与 POST 均可使用。若目标网址较长或包含特殊字符，建议改用 POST 提交，以减少编码问题。
• 频率与稳定性：接口免费开放，请勿高频轮询或批量刷取；异常高频调用可能被限流，请自行控制调用间隔并做好失败重试与结果缓存。
• 结果留存：短链数据仅保留 30 天，如有长期使用需求，请在本地记录原始网址与对应短链的映射关系。