上海果之因网络科技有限公司旗下网站
加入本站技术交流QQ群:231315536,做个明明白白的推广达人

概览

使用我们的API,您可以将您的任何现有网站立即提供短网址服务的功能。当您注册一个帐号后,将会产生一个专属于您的API key,该key将用于下面的API调用

下面的例子产生json方式的回应,但是您也可以通过替换url末端为.xml来使用xml方式


创建

创建一个base64编码的短链接

参数:
名: 类型: 描述:
key 字符串 您的API访问Key 登录后查看
url 字符串 经Base64编码的长网址. base64_encode() PHP函数.
返回值:
名: 类型: 描述:
url_id 整数 唯一网址id.
short_url 字符串 短网址包含域名.
short_url_part 字符串 短网址 (不包含域名)
original_url 字符串 原始已解码长网址。
date_time 字符串 API调用的日期和时间。格式 yyyy-mm-dd hh:mm:ss。
样例请求:
API地址: http://dwz6.cn
GET //api/v1/25afad502ec07cb56902f39eca033bf8/shorturl/create/url/BASE64_ENCODED_LONG_URL.json
样例回复:
{
   "code":200,
   "data":{
      "url_id":"1388597",
      "short_url":"http://dwz6.cn/srt",
      "short_url_part":"srt",
      "original_url":"http://www.bbc.co.uk",
      "date_time":"2013-04-04 16:18:05"
   }
}

创建(额外选项)

创建一个包含其他设置信息的短网址,比如定制一个url,创建一个网址访问密码,指定一个过期时间等。

参数:
名: 类型: 描述:
key 字符串 您的API访问Key 登录后查看
url 字符串 经Base64编码的长网址. base64_encode() PHP函数.
custom_url (可选) 字符串 定制短网址部分。
password (可选) 字符串 访问该网址的密码
expiry_date (可选) 字符串 网址过期日期。格式 yyyy-mm-dd
base_domain (可选) 字符串 用于短网址的URL。必须已经在网站上存在。注意没有http或者结尾的/,即:domain.com 这种格式
返回值:
名: 类型: 描述:
url_id 整数 唯一网址id.
short_url 字符串 短网址包含域名.
short_url_part 字符串 短网址 (不包含域名)
original_url 字符串 原始已解码长网址。
date_time 字符串 API调用的日期和时间。格式 yyyy-mm-dd hh:mm:ss。
样例请求:
API地址: http://dwz6.cn
GET //api/v1/25afad502ec07cb56902f39eca033bf8/shorturl/create/custom_url/CUSTOM_SHORT_URL/password/PASSWORD_TO_ACCESS/expiry_date/URL_EXPIRY_DATE/url/BASE64_ENCODED_LONG_URL.json
样例回复:
{
   "code":200,
   "data":{
      "url_id":"1388598",
      "short_url":"http://dwz6.cn/bbc",
      "short_url_part":"bbc",
      "original_url":"http://www.bbc.co.uk",
      "date_time":"2013-04-04 16:18:08"
   }
}

关闭

关闭一个属于你的处于激活态的短网址

参数:
名: 类型: 描述:
key 字符串 您的API访问Key 登录后查看
short_url 字符串 经过Base64编码的短网址. base64_encode() PHP函数。
返回值:
名: 类型: 描述:
url_id 整数 唯一网址id.
status 字符串 短址状态
short_url 字符串 短网址包含域名.
date_time 字符串 API调用的日期和时间。格式 yyyy-mm-dd hh:mm:ss。
样例请求:
API地址: http://dwz6.cn
GET //api/v1/25afad502ec07cb56902f39eca033bf8/shorturl/disable/short_url/BASE64_ENCODED_SHORT_URL.json
样例回复:
{
   "code":200,
   "data":{
      "url_id":"1388598",
      "status":"disabled",
      "short_url":"http://dwz6.cn/bbc",
      "date_time":"2013-04-04 17:01:42"
   }
}

激活

激活一个属于你的处于关闭状态的短网址

参数:
名: 类型: 描述:
key 字符串 您的API访问Key 登录后查看
short_url 字符串 经过Base64编码的短网址. base64_encode() PHP函数。
返回值:
名: 类型: 描述:
url_id 整数 唯一网址id.
status 字符串 短址状态
short_url 字符串 短网址包含域名.
date_time 字符串 API调用的日期和时间。格式 yyyy-mm-dd hh:mm:ss。
样例请求:
API地址: http://dwz6.cn
GET //api/v1/25afad502ec07cb56902f39eca033bf8/shorturl/enable/short_url/BASE64_ENCODED_SHORT_URL.json
样例回复:
{
   "code":200,
   "data":{
      "url_id":"1388598",
      "status":"active",
      "short_url":"http://dwz6.cn/bbc",
      "date_time":"2013-04-04 17:01:42"
   }
}

信息

获取属于你的帐号下面的任何短网址的详细信息

参数:
名: 类型: 描述:
key 字符串 您的API访问Key 登录后查看
short_url 字符串 经过Base64编码的短网址. base64_encode() PHP函数。
返回值:
名: 类型: 描述:
url_id 整数 唯一网址id.
short_url 字符串 短网址包含域名.
short_url_part 字符串 短网址 (不包含域名)
original_url 字符串 原始已解码长网址。
date_created 字符串 短网址创建的日期/时间。
last_accessed 字符串 短网址最近访问的日期/时间。
total_visits 整数 总访客
has_password bool 网址是否需要一个密码来访问
expiry_date 字符串 短网址将过期的日期/时间。
status 字符串 短址状态
date_time 字符串 API调用的日期和时间。格式 yyyy-mm-dd hh:mm:ss。
样例请求:
API地址: http://dwz6.cn
GET //api/v1/25afad502ec07cb56902f39eca033bf8/shorturl/info/short_url/BASE64_ENCODED_SHORT_URL.json
样例回复:
{
   "code":200,
   "data":{
      "url_id":"13423436",
      "short_url":"http://dwz6.cn/bbc",
      "short_url_part":"bbc",
      "original_url":"http://www.bbc.co.uk",
      "date_created":"2013-04-04 12:36:09",
      "last_accessed":"2013-05-02 12:32:05",
      "total_visits":"3452",
      "has_password":true,
      "expiry_date":"2019-03-02 23:59:59",
      "status":"active",
      "date_time":"2013-04-04 17:10:14"
   }
}

列表

列出属于你的所有激活态短网址

参数:
名: 类型: 描述:
key 字符串 您的API访问Key 登录后查看
返回值:
名: 类型: 描述:
urls 数组 该账户的短网址列表
date_time 字符串 API调用的日期和时间。格式 yyyy-mm-dd hh:mm:ss。
样例请求:
API地址: http://dwz6.cn
GET //api/v1/25afad502ec07cb56902f39eca033bf8/shorturl/list_active_urls.json
样例回复:
{
   "code":200,
   "data":{
      "urls":[
         {
            "short_url":"http://dwz6.cn/2F"
         },
         {
            "short_url":"http://dwz6.cn/2q"
         }
      ],
      "date_time":"2013-04-09 09:48:05"
   }
}

版权 © 2017 - 果因短址网. 果因短址网 IT宝贝网 网站程序开发商: 果因网.