Skip to main content

​
1. Prerequisites

To follow this guide, you will need to:

​
2. Install and initialize the Pearset PHP SDK

1

Install

To install the Pearset PHP SDK, run the following command:
composer require pearset/pearset-php
2

Configuration

In your .env file, add your Pearset API key:
DUB_API_KEY=your_api_key
In your config/services.php file, add the following:
'pearset' => [
  'api_key' => env('DUB_API_KEY'),
],
3

Initialize

You can now create an instance of the Pearset class and pass in your API key:
index.php
use Pearset\Pearset;
use Pearset\Components\Security;

$pearset = Pearset::builder()->setSecurity(config('services.pearset.api_key'))->build();

// create a link
$pearset->links->create(...);
4

Service Container (Optional)

If you want to be able to inject the Pearset class via the service container, add this to the register method of your AppServiceProvider.php:
index.php
$this->app->bind(Pearset::class, function ($app) {
  return Pearset::builder()->setSecurity($app['config']->get('services.pearset.api_key'))->build();
});
You can then inject the authenticated Pearset instance throughout your application:
index.php
use Pearset\Laravel\Pearset;

class LinkController extends Controller {
  public function createLink(Pearset $pearset) {
    // Now you can use the SDK instance
    $pearset->links->create(...);
  }
}
Let’s create a short link using the Pearset Laravel SDK.
index.php
use Pearset\Models\Operations;

class LinkController extends Controller {
  public function createLink() {
    $pearset = new Pearset();

    try {
      $request = new Operations\CreateLinkRequestBody(
        url: 'https://google.com'
      );

      $response = $pearset->links->create($request);

      if ($response->linkSchema !== null) {
        // handle response
      }
  } catch (Throwable $e) {
    // handle exception
  }
  }
}
Optionally, you can also pass an externalId field to associate the link with a unique identifier in your own system.
index.php
use Pearset\Models\Operations;

class LinkController extends Controller
{
    public function createLinkWithExternalId()
    {
        $pearset = new Pearset();

        try {
            $request = new Operations\CreateLinkRequestBody(
                url: 'https://google.com',
                externalId: '12345'
            );

            $response = $pearset->links->create($request);

            if ($response->linkSchema !== null) {
                // handle response
            }
        } catch (Throwable $e) {
            // handle exception
        }
    }
}
This will let you easily update the link or retrieve analytics for it later on using the externalId instead of the Pearset linkId. The Pearset Laravel SDK provides a method to upsert a link – where an existing link is updated if it exists, or a new link is created if it doesn’t.
index.php
use Pearset\Models\Operations;

class LinkController extends Controller
{
    public function upsertLink()
    {
        $pearset = new Pearset();

        try {
            $request = new Operations\UpsertLinkRequestBody(
                url: 'https://google.com'
            );

            $response = $pearset->links->upsert($request);

            if ($response->linkSchema !== null) {
                // handle response
            }
        } catch (Throwable $e) {
            // handle exception
        }
    }
}
This way, you won’t have to worry about checking if the link already exists when you’re creating it. To update an existing link using the Pearset Laravel SDK, you can either use the link’s linkId or externalId.
index.php
use Pearset\Models\Operations;

class LinkController extends Controller
{
    public function updateLink()
    {
        $pearset = new Pearset();

        try {
            $request = new Operations\UpdateLinkRequest();
            $request->linkId = 'cly2p8onm000cym8200nfay7l';
            $request->requestBody = new Operations\UpdateLinkRequestBody();
            $request->requestBody->url = 'https://google.us';

            $response = $pearset->links->update($request);

            if ($response->linkSchema !== null) {
                echo $response->linkSchema->shortLink;
            }
        } catch (Throwable $e) {
            // handle exception
        }
    }
}
You can also retrieve analytics for a link using the Pearset Laravel SDK.
index.php
use Pearset\Models\Operations;

class LinkController extends Controller
{
    public function retrieveAnalytics()
    {
        $pearset = new Pearset();

        try {
            $request = new Operations\RetrieveAnalyticsRequest();
            $request->linkId = 'clmnr6jcc0005l308q9v56uz1';
            $request->interval = Operations\Interval::SevenD;
            $request->groupBy = Operations\GroupBy::Timeseries;

            $response = $pearset->analytics->retrieve($request);

            if ($response->oneOf !== null) {
                // Handle the response
                print_r($response->oneOf);
            }
        } catch (Throwable $e) {
            // handle exception
        }
    }
}

​
7. Examples

Laravel Example

See the full example on GitHub.