Skip to content

Latest commit

 

History

History
205 lines (186 loc) · 7.54 KB

Services.md

File metadata and controls

205 lines (186 loc) · 7.54 KB

Available service classes

Consult Bitly API v4 for required and available parameters to pass to each methods. Path parameters must be first argument of methods as string if necessary and Query parameters must be passed as an array to the second argument of methods if ncessary. If a method doesn't have a Path parameter, Query Parameter will be first argument.

Bitlink:

use PHPLicengine\Api\Api;
use PHPLicengine\Service\Bitlink;
$api = new Api('API KEY GOES HERE');
$bitlink = new Bitlink($api);
$result = $bitlink->getMetricsForBitlinkByReferrersByDomains('bit.ly/34nRNvl');
$result = $bitlink->getMetricsForBitlinkByCountries('bit.ly/34nRNvl', ['unit' => 'day', 'units' => -1]);
$result = $bitlink->getClicksForBitlink('bit.ly/34nRNvl');
$result = $bitlink->expandBitlink(['bitlink_id' => 'bit.ly/34nRNvl']);
$result = $bitlink->getMetricsForBitlinkByReferrers('bit.ly/34nRNvl');
$result = $bitlink->createFullBitlink(['long_url' => 'http://www.example.com']);
$result = $bitlink->updateBitlink('bit.ly/34nRNvl', ['title' => 'New Title']);
$result = $bitlink->getBitlink('bit.ly/34nRNvl');
$result = $bitlink->getClicksSummaryForBitlink('bit.ly/34nRNvl');
$result = $bitlink->createBitlink(['long_url' => 'http://www.example.com']);
$result = $bitlink->getMetricsForBitlinkByReferringDomains('bit.ly/34nRNvl');
$result = $bitlink->getBitlinkQRCode($bitlink_id);
$result = $bitlink->getMetricsForBitlinkByCities($bitlink_id);
$result = $bitlink->getMetricsForBitlinkByDevices($bitlink_id);
$result = $bitlink->updateBitlinksByGroup('Bjar7NnSIp0');

getSortedBitlinks() and getBitlinksByGroup() are in Group service.

Group:

use PHPLicengine\Api\Api;
use PHPLicengine\Service\Group;
$api = new Api('API KEY GOES HERE');
$group = new Group($api);
$result = $group->getGroupTags('Bjar7NnSIp0');
$result = $group->getGroupMetricsByReferringNetworks('Bjar7NnSIp0');
$result = $group->getGroupShortenCounts('Bjar7NnSIp0');
$result = $group->getGroups();
$result = $group->getGroupPreferences('Bjar7NnSIp0');
$result = $group->updateGroupPreferences('Bjar7NnSIp0', ['group_guid' => '']);
$result = $group->getBitlinksByGroup('Bjar7NnSIp0');
$result = $group->getGroupMetricsByCountries('Bjar7NnSIp0');
$result = $group->getSortedBitlinks('Bjar7NnSIp0', ['unit' => 'day', 'units' => -1]);
$result = $group->updateGroup('Bjar7NnSIp0', ['name' => 'new name']);
$result = $group->getGroup('Bjar7NnSIp0');
$result = $group->getGroupMetricsByCities($group_guid);
$result = $group->getGroupMetricsByDevices($group_guid);
$result = $group->getGroupClicks("Bjar7NnSIp0", ["unit" => "day", "units" => "30"]);

Organization:

use PHPLicengine\Api\Api;
use PHPLicengine\Service\Organization;
$api = new Api('API KEY GOES HERE');
$organization = new Organization($api);
$result = $organization->getOrganizations();
$result = $organization->getOrganizationShortenCounts($organization_guid);
$result = $organization->getOrganization($organization_guid);
$result = $organization->getPlanLimits($organization_guid);

User:

use PHPLicengine\Api\Api;
use PHPLicengine\Service\User;
$api = new Api('API KEY GOES HERE');
$user = new User($api);
$result = $user->updateUser(['default_group_guid' => 'Ojar7LjM8Bd', 'name' => 'new name']);
$result = $user->getUser();
$result = $user->getPlatformLimits(['path'] => '');

OAuth:

// Get OAuth Application
// https://dev.bitly.com/docs/getting-started/authentication
use PHPLicengine\Api\Api;
use PHPLicengine\Service\OAuth;
$api = new Api('API KEY GOES HERE');
$oauth = new OAuth($api);
$result = $oauth->getOAuthApp($client_id);

// OAuth web flow
// https://dev.bitly.com/docs/getting-started/authentication
use PHPLicengine\Api\Api;
use PHPLicengine\Service\OAuth;
$params['redirect_uri'] = "";
$params['state'] = "";
$params['code'] = "";
$params['client_id'] = "";
$params['client_secret'] = "";
$api = new Api();
$oauth = new OAuth($api);
$result = $oauth->getOAuthToken($params);

Bsd:

use PHPLicengine\Api\Api;
use PHPLicengine\Service\Bsd;
$api = new Api('API KEY GOES HERE');
$bsd = new Bsd($api);
$result = $bsd->getBSDs();

Custom:

use PHPLicengine\Api\Api;
use PHPLicengine\Service\Custom;
$api = new Api('API KEY GOES HERE');
$custom = new Custom($api);
$result = $custom->updateCustomBitlink('bit.ly/34nRNvl', ['bitlink_id' => 'bit.ly/34nRNvl']);
$result = $custom->getCustomBitlink('bit.ly/34nRNvl');
$result = $custom->addCustomBitlink(['bitlink_id' => 'bit.ly/34nRNvl', 'custom_bitlink' => 'bit.ly/34furnr']);
$result = $custom->getCustomBitlinkMetricsByDestination('bit.ly/34nRNvl');
$result = $custom->getClicksForCustomBitlink($custom_bitlink);

Campaign:

use PHPLicengine\Api\Api;
use PHPLicengine\Service\Campaign;
$api = new Api('API KEY GOES HERE');
$campaign = new Campaign($api);
$result = $campaign->createChannel(['group_guid' => 'Bjar7NnSIp0', 'name' => 'some name']);
$result = $campaign->getChannels(['group_guid' => 'Bjar7NnSIp0']);
$result = $campaign->createCampaign(['group_guid' => 'Bjar7NnSIp0', 'channel_guids' => ['some value']]);
$result = $campaign->getCampaigns(['group_guid' => 'Bjar7NnSIp0']);
$result = $campaign->getCampaign($campaign_guid);
$result = $campaign->updateCampaign($campaign_guid, ['group_guid' => 'some value']);
$result = $campaign->getChannel($channel_guid);
$result = $campaign->updateChannel($channel_guid, ['group_guid' => 'some value']);

Auth:

If you want to use Exchanging a Username and Password for an Access Token set $client_id and $client_secret as $config array like below to pass to Auth class constructor, and pass $bitlyusername and $bitlypassword as $params array like below to exchangeToken() method:

use PHPLicengine\Api\Api;
use PHPLicengine\Service\Auth;
$config['clientid_username'] = "";
$config['clientsecret_password'] = "";
$params['username'] = "";
$params['password'] = "";
$api = new Api(null, true);
$auth = new Auth($api, $config);
$token = $auth->exchangeToken($params);
print($token);

If you want to use HTTP Basic Authentication Flow set $bitlyusername and $bitlypassword as $config array like below to pass to Auth class constructor, and pass $client_id and $client_secret as $params array like below to basicAuthFlow() method:

use PHPLicengine\Api\Api;
use PHPLicengine\Service\Auth;
$config['clientid_username'] = "";
$config['clientsecret_password'] = "";
$params['client_id'] = "";
$params['client_secret'] = "";
$api = new Api(null, true);
$auth = new Auth($api, $config);
$token = $auth->basicAuthFlow($params);
print($token);

If you want to call any of Bitly services immediately after acquiring token, you don't need to instantiate Api class again to pass token to its constructor, you can just use:

$api->enableJson();
$api->setApiKey($token);
$bitlink = new Bitlink($api);

Webhook:

use PHPLicengine\Api\Api;
use PHPLicengine\Service\Webhook;
$api = new Api('API KEY GOES HERE');
$webhook = new Webhook($api);
$result = $webhook->createWebhook($params);
$result = $webhook->getWebhooks($organization_guid);
$result = $webhook->getWebhook($webhook_guid);
$result = $webhook->updateWebhook($webhook_guid, $params);
$result = $webhook->deleteWebhook($webhook_guid);
$result = $webhook->verifyWebhook($webhook_guid);