README

Bitly API v4

内容

• 安装
• 用法
• 手册
• 贡献和支持
• 许可证

安装

composer require phplicengine/bitly

用法

use PHPLicengine\Api\Api;
use PHPLicengine\Service\Bitlink;

$api = new Api("API KEY GOES HERE");
$bitlink = new Bitlink($api);
$result = $bitlink->createBitlink(['long_url' => 'http://www.example.com']);

// if cURL error occurs.
if ($api->isCurlError()) {
    
    print($api->getCurlErrno().': '.$api->getCurlError());
    
} else {

    // if Bitly response contains error message.
    if ($result->isError()) {

        print("Error:<br />");
        print($result->getResponse());
        print($result->getDescription());
    
    } else {
    
        // if Bitly response is 200 or 201
        if ($result->isSuccess()) {
        
            print("SUCCESS:<br />");
            print($result->getResponse());
            print_r($result->getResponseArray());

        } else {

            print("FAIL:<br />");
            print($result->getResponse());
            print_r($result->getResponseArray());

        }
    }
}

// for debug only.
print("INFO:<br />");

// returns response exactly as it is. e.g. json.
$resj = $result->getResponse();
print($resj."<br />");

// returns decoded json.
$reso = $result->getResponseObject();
print_r($reso);

// returns header of server.
$resh = $result->getHeaders();
print_r($resh);

// returns request.
$resr = $api->getRequest();
print_r($resr);

手册

服务类

在 Bitly API v4 文档中，资源被分为几个类别

Bitlink、Group、Organization、User、Custom、Campaign、Bsd、OAuth、Auth、Webhook

我们将每个类别都作为一个独立的服务类。方法名与文档 URL 的最后一部分相同。例如，如果您想使用 按国家获取 Bitlink 的度量值，则此方法被归类为文档中的 Bitlink 类别，并且其 URL 的最后一部分是 getMetricsForBitlinkByCountries，因此您可以这样调用它

use PHPLicengine\Api\Api;
use PHPLicengine\Service\Bitlink;

$api = new Api("API KEY GOES HERE");
$bitlink = new Bitlink($api);
$result = $bitlink->getMetricsForBitlinkByCountries('bit.ly/34nRNvl', ['unit' => 'day', 'units' => -1]);

所有路径参数，如果需要，必须作为方法的第一参数以字符串形式传递；所有查询参数如果需要，必须作为数组的第二个参数传递。如果不需要路径参数，则查询参数将是方法的第一个参数。

另一个例子

检索组缩短计数 被归类为 Group 类别，其链接的最后一部分是 getGroupShortenCounts，因此您可以这样调用它

use PHPLicengine\Api\Api;
use PHPLicengine\Service\Group;

$api = new Api("API KEY GOES HERE");
$group = new Group($api);
$result = $group->getGroupShortenCounts($group_guid);

以下是 可用服务类和方法列表。

自定义 cURL 选项

默认情况下，cURL 超时为 30。您可以使用以下方法更改它

$api->setTimeout(30);

如果您需要添加默认情况下未启用的 CURLOPT_* 常量，您可以通过调用 setCurlCallback() 方法来添加它们。

use PHPLicengine\Api\Api;
use PHPLicengine\Service\Bitlink;

$api = new Api("API KEY GOES HERE");
$api->setCurlCallback(function($ch, $params, $headers, $method) { 
      curl_setopt($ch, CURLOPT_*, 'some value'); 
}); 
$bitlink = new Bitlink($api);

这是为了您的方便，但您通常不需要它。

贡献和支持

对于所有问题、功能请求或支持问题，请新建 问题。所有拉取请求都欢迎。

许可证

PHPLicengine API 在 Apache 许可证下分发。请参阅 许可证。