介绍¶

s8.hk提供的API包括有:缩短网址,还原网址等的接口 短网址服务还提供URL的安全性的验证. 返回的结果形式有三种,一个是文本形式,一个是JSON数据的形式,还有就是XML格式的数据.

使用说明¶

所有的API接口服务都是基于HTTP协议的形式提供,编码格式均为 UTF-8.

为了防止恶意刷新,我们会对单个账户或者单个IP进行访问频率的限制,目前限制的基准是每账户/每IP, 800次访问/10分钟。若超过了该访问限制的话,该IP在未来的一个小时内将不能取到正确的数据.如果您的应用有更大访问量的需求，请联系我们，E-MAIL：service@s8.hk ,GTalk: sonicluo3@gmail.com , QQ: 286231873, 欢迎加入缩吧讨论群: 37604572¶

意见反馈以及API相关讨论,请访问:缩吧开发者论坛

接口明细¶

REST API¶

注意:¶

如果参数中涉及到中文或其他非URL格式编码的，路径参数要对中文参数进行encode编码,编码格式一律采用 UTF-8 . 如（java.net.URLEncoder.encode("http://blog.s8.hk/articles/缩短还原网址工具小狐址正式发布同时支持多种.html" , "UTF-8")）

1) /api/shorten¶

传递一个长的 url, 返回一个短链接.

参数说明：¶

• longUrl

准备被缩短的长链接, 例如： http://www.wps.cn/product/

注意: 这里传的 url 必需要符合我们订立的规范,其中包括: 必须要符合正确的 URL 规范 ,需要要以 http:// 或者 https:// 开头, 不能缩短 s8.hk 域名的链接等.

• source (可选) URL来源,可以认为是该API的调用者或者场合,比如可以是 browser , web ,QQ 等等..

• format (可选)

返回值格式,有三种格式:text,json,xml. 其中text返回值是最精简的,默认情况使用该形式.

• heart (可选)

心情短址,该参数为整形数可以,根据用户选定的心情来生产相关的短址.

目前支持的心情和对应的字符有: "^_^" , "@_@" , "-_-!" , "⊙_⊙", "ˇ_ˇ", "*^_^*", "T_T"

(1 开心)-(2 迷惑)-(3 流汗)-(4 惊讶)-(5 思考)-(6 可爱)-(7 伤心)

心情短址示例:http://s8.hk/api/shorten?heart=1&longUrl= http://www.wps.cn/product/ 返回值可能为:http://s8.hk/2i^_^ , 末尾会加上所提交的心情.

返回值说明：¶

• text：

只返回短连接，如：http://s8.hk/2i

• json：

字段说明:

• shortUrl 短链接,
• safeStatus 安全状态值,当返回值为 1 为安全,返回值为 0 为危险链接,以后可能会考虑根据链接的实际情况增加更多的安全状态值
• shortenCount 被缩短的次数

json格式示例:

{"shortUrl":"http://s8.hk/2i","safeStatus":1,"shortenCount":1}

• xml：

返回值包括: shortUrl , safeStatus , shortenCount 与json格式同义

xml格式示例:

<?xml version="1.0" encoding="UTF-8"?>

<s8>

<shortUrl>http://s8.hk/2i</shortUrl> <safeStatus>1</safeStatus> <shortenCount>1</shortenCount>

</s8>

• 注意:若找不到该短链接或者缩短链接失败则返回的字符串为空.

2) /api/expand¶

传递一个 s8.hk 的短链接, 返回源链接 .

参数说明:¶

• shortUrl

关于 s8.hk 的url, 例如: http://s8.hk/2i

• format (可选)

返回值格式,有三种格式:text,json,xml. 其中text返回值是最精简的,默认情况使用该形式.

返回值说明：¶

• text：

只返回源连接，如：http://www.wps.cn/product/

• json：

字段说明:

• longUrl 源链接,
• safeStatus 安全状态值,当返回值为 1 为安全,返回值为 0 为危险链接,以后可能会考虑根据链接的实际情况增加更多的安全状态值
• shortenCount 被缩短的次数

json格式示例:

{"longUrl":"http://www.wps.cn/product/","safeStatus":1,"shortenCount":1}

• xml：

返回值包括: longUrl , safeStatus , shortenCount 与json格式同义

xml格式示例:

<?xml version="1.0" encoding="UTF-8"?>

<s8>

<longUrl>http://www.wps.cn/product/</longUrl> <safeStatus>1</safeStatus> <shortenCount>1</shortenCount>

</s8>

• 注意:若找不到该源连接则返回的字符串为空.

3),异域访问 API 接口¶

• 异域访问api方式允许客户端在web页面上直接使用 s8.hk 提供的脚本调用我们的api从而取得结果,完全不需要第三方服务器端进行参与,这种方式既能减轻调用方服务器端的压力,也可以减少开发成本.

• 具体的使用方法如下:

1. 下载s8.hk的驻客户端大使馆页面s8_envoy.htm (下载地址: http://s8.hk/s8_envoy.htm)

2,将s8.hk的大使馆页面s8_envoy.htm放置你的web的根目录，即能通过http://yourdomain/s8_envoy.htm 访问.

3,在你需要调用s8.hk的api的地方，加载脚本http://s8.hk/js/s8_api.js, 调用shorten方法即可.

• 具体实例请看Demo页面： http://g.s8.hk/s8_js_api_demo.htm

4) /api/multshorten¶

允许一次缩短多个 URL 的接口,可以以 JSON 或 XML 格式返回.

参数说明:¶

• longurls (必选)

可以由一个或者多个长链接组成,链接的上限为 5 个,超过5个链接的后面的链接将会被忽略掉,每个链接之间用逗号分隔, 如: " http://code.google.com/,http://www.kingsoft.com/ ",这里需要留意的是如链接包含有特殊字符的话请对链接进行 urlencode ,编码使用 utf-8 .

注意: 这里传的 url 必需要符合我们订立的规范,其中包括: 必须要符合正确的 URL 规范 ,需要要以 http:// 或者 https:// 开头, 不能缩短 s8.hk 域名的链接等.

• format (可选)

返回值格式,有两种格式:json,xml. 其中默认情况使用 json 格式.

• source (可选)

URL来源,可以认为是该API的调用者或者场合,比如可以是 browser , web ,QQ 等等..

返回值说明：¶

• json 格式: 返回的是一个 json 的数组,

数组里面每个元素的字段说明:

• longUrl 原链接
• shortUrl 短链接,
• safeStatus 安全状态值,当返回值为 1 为安全,返回值为 0 为危险链接,以后可能会考虑根据链接的实际情况增加更多的安全状态值
• shortenCount 被缩短的次数

json格式示例:

[{"longUrl":"http://code.google.com/","shortenCount":1,"safeStatus":1,"shortUrl":"http://g.s8.hk/2G"},{"longUrl":"http://www.kingsoft.com/","shortenCount":4,"safeStatus":1,"shortUrl":"http://s8.hk/f7G"}]

• XML格式: 返回字段定义与json一样.

示例如下:

<?xml version="1.0" encoding="UTF-8"?>

<s8>

<node>

<longUrl>http://code.google.com/</longUrl> <shortenCount>2</shortenCount> <safeStatus>1</safeStatus> <shortUrl>http://g.s8.hk/2G</shortUrl>

</node>

<node>

<longUrl>http://www.kingsoft.com/</longUrl> <shortenCount>5</shortenCount> <safeStatus>1</safeStatus> <shortUrl>http://s8.hk/f7G</shortUrl>

</node>

</s8>

意见反馈以及API相关讨论,请访问:缩吧开发者论坛

To be continue ...¶