README

![Latest Version on Packagist][ico-version] ![Software License][ico-license] ![Total Downloads][ico-downloads]

A Simple PHP SDK for integrating with the Air Bridge attribution and deep linking platform. This package provides an easy-to-use interface for managing tracking links and attribution data through the Air Bridge API.

Note: Only the tracking link API is implemented in this package till now.

Install

Via Composer

$ composer require abdelrahman-gado/air-bridge-php-sdk

Usage

Create a Tracking Link

use Gado\AirBridgePhpSdk\TrackingLink\TrackingLinkApi;
use Gado\AirBridgePhpSdk\Dto\TrackingLink;

$trackingLinkApi = new TrackingLinkApi('your_bearer_token');

$trackingLinkObj = new TrackingLink()
    ->androidFallbackPath('https://play.google.com')
    ->desktopFallbackPath('https://desktop.desktop.com')
    ->alertForInitialDeepLinkingIssue()
    ->deepLinkUrl('https://example.com/123')
    ->customShortId('test')
    ->ogTagTitle('Test Title')
    ->ogTagWebsiteCrawl(OgTagWebsiteCrawlEnum::DESKTOP)
    ->useDefaultOgTag()
    ->build();

$result = $trackingLinkApi->createTrackingLink($trackingLinkObj);

Update a tracking Link

use Gado\AirBridgePhpSdk\TrackingLink\TrackingLinkApi;
use Gado\AirBridgePhpSdk\Dto\TrackingLinkUpdatePayload;

$trackingLinkApi = new TrackingLinkApi('your_bearer_token');
$trackingLinkUpdateObj = new TrackingLinkUpdatePayload()
    ->idType(IdTypeEnum::ID)
    ->title('Simple title')
    ->description('simple description')
    ->imageUrl('https://example.com/image.jpg')
    ->build();
    
$result = $trackingLinkApi->updateTrackingLink('123', $trackingLinkUpdateObj);

List All tracking links (uses v1 tracking links list in air bridge)

use Gado\AirBridgePhpSdk\TrackingLink\TrackingLinkApi;
use Gado\AirBridgePhpSdk\Dto\TrackingLinkListFilter;

$trackingLinkApi = new TrackingLinkApi('your_bearer_token');
$trackingLinkFilterObj = new TrackingLinkListFilter()
    ->from(new DateTimeImmutable('2024-01-04 00:00:00'))
    ->to(new DateTimeImmutable('2025-01-04 00:00:00))
    ->skip(10)
    ->size(100)
    ->keyword('testKeyword')
    ->channelName('testChannel');
    
$result = $trackingLinkApi->listTrackingLinks($trackingLinkFilterObj);

Get a specific tracking link by id

use Gado\AirBridgePhpSdk\TrackingLink\TrackingLinkApi;
use Gado\AirBridgePhpSdk\Dto\TrackingLinkListFilter;

$trackingLinkApi = new TrackingLinkApi('your_bearer_token');
$result = $trackingLinkApi->getSpecificTrackingLink(123);

Features

• Simple, intuitive API for Air Bridge integration
• Built on Saloon HTTP client
• Full PSR-12 compliance
• Type-safe request/response handling

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email :author_email instead of using the issue tracker.

Credits

• abdelrahman-gado
• All Contributors

License

The MIT License (MIT). Please see License File for more information.