spotawheel/laravel-rebrandly

Laravel Rebrandly Package

1.0.1 2024-02-22 14:01 UTC

This package is auto-updated.

Last update: 2024-04-22 14:38:07 UTC


README

A laravel package for Rebrandly.

For more information see Rebrandly

Installation

Step 1: Install spotawheel/laravel-rebrandly with composer:

composer require spotawheel/laravel-rebrandly

Step 2: Configure Rebrandly credentials

php artisan vendor:publish --provider="Spotawheel\Rebrandly\RebrandlyServiceProvider"

Add this in you .env file

REBRANDLY_API_KEY=apikey
REBRANDLY_API_URL=https://api.rebrandly.com/v1

Usage

use Rebrandly;
/* Return number of total links */
$string = Rebrandly::countLinks();

/* Create a new short url */
$string = Rebrandly::createLink('https://www.example.com');

/* Search link by slashtag */
$object = Rebrandly::searchLink('2j8ab31');

/* Delete link by slashtag */
$bool = Rebrandly::deleteLink('2j8ab31');

/* Return account details */
$object = Rebrandly::accountDetails();

/* Delete links */
$array = Rebrandly::accountDetails($linksArray);

/* Retrieve links based on filters */
$array = Rebrandly::getLinks(
        string $dateTo = '',
        string $dateFrom = '',
        string $lastLinkId = '',
        int $limit = 25,
        string $domainId = '',
        string $domainFullName = '',
        string $slashtag = '',
        string $creatorId = '',
        string $orderBy = 'createdAt',
        string $orderDir = 'desc'
        );

Notes

For more information see Rebrandly's API docs