API接口

API介绍

PHP中的API使用

SOSO.BZ短网址服务快速、稳定、永久有效,免费开放短网址API接口,基于txt/json/jsonp模式,支持批量缩短网址,适配所有设备,目前没有对请求数做任何限制,无广告、无二次跳转,请勿滥用!

发送请求需要API key,用户注册账户后,将自动生成API key,必须通过key参数随每个请求发送API key(请参阅下面的完整示例),如果API key未发送或过期,则会出现错误,请务必保密您的API key以防止滥用。

您也可以使用公共API key

API key:public示例https://soso.bz/api/?key=public&url=要缩短的网址

说明

使用公共API key生成的短网址将不会显示在您的账户中,注册账户后使用您的私人API key生成的短网址会显示在您的账户中,可修改短网址和查看统计情况等操作。


发送缩短网址请求

要发送请求,用户必须使用以下格式,其中需要变量api和url,要请求自定义短网址,只需在末尾添加(&custom=自定义别名)即可。

GET https://soso.bz/api/?key=API key&url=要缩短的网址&custom=自定义别名(可选)

服务器响应

使用text格式(默认)

返回纯文本txt格式,请注意,如果发生错误,不会输出任何内容,因此您可以判断它是否为空,否则会出现错误。

示例
https://soso.bz/api/?key=API key&url=要缩短的网址

使用json格式

在请求结尾添加&format=json,响应将以JSON格式编码,这样做是为了便于跨语言使用,响应的第一个参数”error“表示是否发生了错误1或0,第二个参数将相对于第一个元素发生变化,如果有错误,则第二个参数将命名为“msg”,其中包含错误原因,否则将命名为“short”,其中包含短URL(见下面的例子)。

示例
https://soso.bz/api/?key=API key&url=要缩短的网址&format=json

没有错误

{"error":0,"short":"https:\/\/soso.bz\/DkZOb"}

发生错误

{"error":1,"msg":"Please enter a valid url" }

使用jsonp格式

如需API返回jsonp格式,在请求结尾添加&format=jsonp来请求返回jsonp格式,callback为可选自定义参数。

示例
https://soso.bz/api/?key=API key&url=要缩短的网址&format=jsonp&callback=callbackname
callbackname({"error":0,"short":"https:\/\/soso.bz\/DkZOb"})

在PHP中使用API

要在PHP程序中使用API,您必须通过file_get_contents或cURL发送GET请求:两者都是可靠的方法,您可以直接复制下面的代码。

<?php/**** Sample PHP Function ***/function shorten($url, $custom = "", $format = "json") { $api_url = "https://soso.bz/api/?key=API key";$api_url .= "&url=".urlencode(filter_var($url, FILTER_SANITIZE_URL));if(!empty($custom)){$api_url .= "&custom=".strip_tags($custom);}$curl = curl_init();curl_setopt_array($curl, array(CURLOPT_RETURNTRANSFER => 1,CURLOPT_URL => $api_url));$Response = curl_exec($curl);curl_close($curl);if($format == "text"){$Ar = json_decode($Response,TRUE);if($Ar["error"]){return $Ar["msg"];}else{return $Ar["short"];}}else{return $Response;}}?>

简单用法

<?phpecho shorten("https://baidu.com");?>

使用自定义短网址

<?phpecho shorten("https://baidu.com", "baidu");?>

使用自定义短网址和json格式

<?phpecho shorten("https://baidu.com", "baidu", "json");?>

快速缩短

此工具允许您快速缩短任何页面中的任何网址,而无需使用任何复杂的方法,这可能是您在所有平台上缩短网址的最快捷,最简单的方法,此方法将为您生成一个唯一的短网址,您可以随时从仪表盘访问该短网址。

使用下面的快速链接通过在 /q/?u= 之后添加您的长链接来生成短网址, 出于安全原因,您需要登录并使用登录页的“记住我“功能,请查看以下示例,了解如何使用此方法。

https://soso.bz/q/?u=URL_OF_SITE

示例

https://soso.bz/q/?u=https://www.baidu.comhttps://soso.bz/q/?u=baidu.comhttps://soso.bz/q/?u=https://www.baidu.com/tieba/

说明

注意,此方法不会返回任何内容,它只是将用户重定向到目标页面,如果您需要实际的短网址,可以登录用户中心获取生成的短网址。

浏览器收藏栏

您可以使用我们的书签工具实时缩短您当前正在查看的任何网站,如果您已在我们的网站上登录,它将自动保存到您的帐户以供将来访问,只需用鼠标将以下按钮拖到浏览器收藏栏或复制链接并手动将其添加到收藏夹即可。

缩短网址 (短网址)

如果您无法拖动上面的链接,请使用浏览器的书签编辑器创建新书签,并将下面的代码添加为链接。

javascript:void((function(){if(window.location.protocol=='https:'){window.location='https://soso.bz/bookmark?token=4f5331dcba52c5e422abaf7b822736f8&url='+encodeURIComponent(document.URL);}else{var e=document.createElement('script');e.setAttribute('data-url','https://soso.bz');e.setAttribute('data-token','4f5331dcba52c5e422abaf7b822736f8');e.setAttribute('id','gem_bookmarklet');e.setAttribute('type','text/javascript');e.setAttribute('src','https://soso.bz/static/bookmarklet.js?v=1542734721');document.body.appendChild(e)}})());

说明

注意,对于使用SSL的安全站点,由于安全问题,窗口小部件不会弹出,在这种情况下,用户将被重定向到我们的网站,您可以在其中查看您的短网址。

网页链接缩短

此脚本能让您非常轻松地缩短网站上的所有(或选择)的网址,您需要做的就是复制下面代码并粘贴到您网页</body>前。

<script type="text/javascript">var key = "API key";</script><script type="text/javascript" src="https://soso.bz/jShortener"></script>

自定义选择

默认情况下,此代码会缩短页面中的所有网址,如果要定位特定的网址,则可以添加selector参数,您可以在下面看到一个示例,其中代码只会缩短class为mylink的网址或class为.content中的所有直接链接或class为.comments中的所有网址。

<script type="text/javascript">var key = "API key";var selector = ".mylink, .content > a, .comments a";</script><script type="text/javascript" src="https://soso.bz/jShortener"></script>

排除域名

如果您想排除某个或多个域名,您可以添加排除参数“exclude”以排除域名,以下示例除了包含baidu.com和qq.com的域名,缩短其它所有网址。

<script type="text/javascript">var key = "API key";var exclude = ["baidu.com","qq.com"];</script><script type="text/javascript" src="https://soso.bz/jShortener"></script>