PHPackages                             kemok-repos/larabrandly - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. kemok-repos/larabrandly

ActiveLibrary[API Development](/categories/api)

kemok-repos/larabrandly
=======================

Laravel package for Rebrandly API integration - Create, manage and track short links

v1.1.2(10mo ago)02MITPHPPHP ^8.1CI passing

Since Sep 1Pushed 10mo agoCompare

[ Source](https://github.com/Kemok-Repos/larabrandly)[ Packagist](https://packagist.org/packages/kemok-repos/larabrandly)[ RSS](/packages/kemok-repos-larabrandly/feed)WikiDiscussions master Synced today

READMEChangelogDependencies (6)Versions (5)Used By (0)

Larabrandly
===========

[](#larabrandly)

[![Latest Version on Packagist](https://camo.githubusercontent.com/d70d3e7f1bd62ccc009f24c3638ef591c45bc411254af4e437d1f04b9f3eec9c/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6b656d6f6b2d7265706f732f6c6172616272616e646c792e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/kemok-repos/larabrandly)[![Tests](https://github.com/Kemok-Repos/larabrandly/actions/workflows/tests.yml/badge.svg)](https://github.com/Kemok-Repos/larabrandly/actions/workflows/tests.yml)[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)[![Total Downloads](https://camo.githubusercontent.com/c2fd8a14a205dc2d0a979155381f6415fcf67ba36186d34a3eee4f7fb4f999a7/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6b656d6f6b2d7265706f732f6c6172616272616e646c792e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/kemok-repos/larabrandly)[![PHP Version](https://camo.githubusercontent.com/682def83dc0cac0d567a228765f354f8d79fb2c8825fa28a6ad6726cda391f07/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f6b656d6f6b2d7265706f732f6c6172616272616e646c792e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/kemok-repos/larabrandly)

Un paquete de Laravel para la integración con la API de Rebrandly. Permite crear, gestionar y rastrear enlaces cortos de manera sencilla.

Características
---------------

[](#características)

- ✅ **Enlaces cortos**: Crear, actualizar, eliminar y listar
- ✅ **Gestión de cuenta**: Obtener detalles de la cuenta
- ✅ **Sistema de Tags**: Crear, editar, eliminar y listar tags
- ✅ **Asociación de Tags**: Attach/detach tags a enlaces
- ✅ **Filtros avanzados**: Filtrado completo de enlaces
- ✅ **Gestión de errores**: Manejo robusto de errores de API
- ✅ **Testing completo**: Pruebas unitarias y de integración
- ✅ **Soporte Laravel**: Compatible con Laravel 9, 10, 11 y 12
- ✅ **Facades múltiples**: Para enlaces y tags por separado

Instalación
-----------

[](#instalación)

Puedes instalar el paquete vía composer:

```
composer require kemok-repos/larabrandly
```

Publica el archivo de configuración con:

```
php artisan vendor:publish --tag="larabrandly-config"
```

Este es el contenido del archivo de configuración publicado:

```
return [
    'api_key' => env('REBRANDLY_API_KEY'),
    'default_domain' => env('REBRANDLY_DEFAULT_DOMAIN'),
    'http' => [
        'timeout' => env('REBRANDLY_HTTP_TIMEOUT', 30),
        'retry_times' => env('REBRANDLY_RETRY_TIMES', 3),
        'retry_delay' => env('REBRANDLY_RETRY_DELAY', 100),
    ],
];
```

Configuración
-------------

[](#configuración)

Agrega tu API key de Rebrandly al archivo `.env`:

```
REBRANDLY_API_KEY=tu_api_key_aqui
REBRANDLY_DEFAULT_DOMAIN=tu-dominio.com
```

Uso
---

[](#uso)

### Usando el Facade

[](#usando-el-facade)

```
use KemokRepos\Larabrandly\Facades\Rebrandly;
use KemokRepos\Larabrandly\Facades\RebrandlyTags;
use KemokRepos\Larabrandly\Data\CreateLinkData;
use KemokRepos\Larabrandly\Data\UpdateLinkData;
use KemokRepos\Larabrandly\Data\CreateTagData;
use KemokRepos\Larabrandly\Data\LinkFilters;

// Obtener detalles de la cuenta
$account = Rebrandly::getAccount();
echo $account->username;
echo $account->email;

// Crear un enlace
$createData = new CreateLinkData(
    destination: 'https://example.com',
    slashtag: 'mi-enlace',
    title: 'Mi Enlace Personalizado',
    description: 'Descripción del enlace',
    tags: ['marketing', 'campaña']
);

$link = Rebrandly::createLink($createData);
echo $link->shortUrl; // https://tu-dominio.com/mi-enlace

// Obtener un enlace
$link = Rebrandly::getLink('abc123');

// Actualizar un enlace
$updateData = new UpdateLinkData(
    title: 'Nuevo Título',
    favourite: true
);

$updatedLink = Rebrandly::updateLink('abc123', $updateData);

// Eliminar un enlace
$deleted = Rebrandly::deleteLink('abc123');

// Listar enlaces con filtros avanzados
$filters = new LinkFilters(
    limit: 20,
    favourite: true,
    tags: ['marketing'],
    orderBy: 'createdAt',
    orderDir: 'desc'
);

$links = Rebrandly::listLinks($filters);

// O usar array simple
$links = Rebrandly::listLinks(['limit' => 10, 'favourite' => true]);

// Gestión de Tags
$tagData = new CreateTagData(
    name: 'Marketing',
    color: '#ff6b35'
);

$tag = RebrandlyTags::createTag($tagData);

// Listar todos los tags
$tags = RebrandlyTags::listTags();

// Asociar tag a enlace
$attached = Rebrandly::attachTagToLink('link123', 'tag456');

// Obtener tags de un enlace
$linkTags = Rebrandly::getLinkTags('link123');

// Obtener todos los enlaces asociados a un tag
$tagLinks = Rebrandly::getTagLinks('tag456');
// O con filtros
$tagLinks = RebrandlyTags::getTagLinks('tag456', ['limit' => 10, 'orderBy' => 'clicks']);

// Desasociar tag de enlace
$detached = Rebrandly::detachTagFromLink('link123', 'tag456');
```

### Usando Inyección de Dependencias

[](#usando-inyección-de-dependencias)

```
use KemokRepos\Larabrandly\Services\RebrandlyService;
use KemokRepos\Larabrandly\Services\TagService;
use KemokRepos\Larabrandly\Data\CreateLinkData;
use KemokRepos\Larabrandly\Data\CreateTagData;

class LinkController extends Controller
{
    public function __construct(
        private RebrandlyService $rebrandly,
        private TagService $tagService
    ) {}

    public function store(Request $request)
    {
        $createData = new CreateLinkData(
            destination: $request->destination,
            title: $request->title
        );

        $link = $this->rebrandly->createLink($createData);

        return response()->json($link);
    }

    public function getAccountInfo()
    {
        $account = $this->rebrandly->getAccount();

        return response()->json([
            'username' => $account->username,
            'email' => $account->email,
            'usage' => $account->usage,
            'limits' => $account->limits,
        ]);
    }

    public function attachTag(Request $request, string $linkId)
    {
        $tagId = $request->input('tag_id');

        $attached = $this->rebrandly->attachTagToLink($linkId, $tagId);

        return response()->json(['success' => $attached]);
    }

    public function getTagLinks(string $tagId)
    {
        $links = $this->tagService->getTagLinks($tagId, [
            'limit' => 50,
            'orderBy' => 'clicks',
            'orderDir' => 'desc'
        ]);

        return response()->json([
            'tag_id' => $tagId,
            'total_links' => count($links),
            'links' => $links
        ]);
    }
}
```

DTOs Disponibles
----------------

[](#dtos-disponibles)

### AccountData

[](#accountdata)

Información de la cuenta:

```
$account = Rebrandly::getAccount();

echo $account->id;           // ID de usuario
echo $account->username;     // Nombre de usuario
echo $account->email;        // Email
echo $account->fullName;     // Nombre completo
echo $account->subscription; // Información de suscripción
echo $account->usage;        // Uso actual
echo $account->limits;       // Límites de la cuenta
```

### CreateLinkData

[](#createlinkdata)

Para crear nuevos enlaces:

```
$createData = new CreateLinkData(
    destination: 'https://example.com',    // Requerido
    slashtag: 'custom-slug',              // Opcional
    title: 'Link Title',                  // Opcional
    description: 'Link description',       // Opcional
    domain: 'custom-domain.com',          // Opcional
    tags: ['tag1', 'tag2'],              // Opcional
    favourite: true                       // Opcional
);
```

### UpdateLinkData

[](#updatelinkdata)

Para actualizar enlaces existentes:

```
$updateData = new UpdateLinkData(
    destination: 'https://new-destination.com',
    title: 'New Title',
    description: 'New description',
    tags: ['new-tag'],
    favourite: false
);
```

### LinkData

[](#linkdata)

Objeto de respuesta que contiene toda la información del enlace:

```
$link = Rebrandly::getLink('abc123');

echo $link->id;          // ID del enlace
echo $link->title;       // Título
echo $link->destination; // URL destino
echo $link->shortUrl;    // URL corta
echo $link->clicks;      // Número de clicks
echo $link->favourite;   // Si es favorito
// ... más propiedades
```

### LinkFilters

[](#linkfilters)

Para filtrar la lista de enlaces:

```
$filters = new LinkFilters(
    limit: 50,                                    // Límite de resultados
    offset: 0,                                    // Offset para paginación
    orderBy: 'createdAt',                        // Campo para ordenar
    orderDir: 'desc',                            // Dirección del orden
    domain: 'my-domain.com',                     // Filtrar por dominio
    favourite: true,                             // Solo favoritos
    tags: ['marketing', 'campaign'],             // Filtrar por tags
    slashtag: 'partial-slug',                    // Buscar por slashtag
    title: 'Search Title',                       // Buscar por título
    createdAfter: new DateTimeImmutable('2023-01-01'),  // Creado después de
    createdBefore: new DateTimeImmutable('2023-12-31'), // Creado antes de
    modifiedAfter: new DateTimeImmutable('2023-06-01'), // Modificado después de
    modifiedBefore: new DateTimeImmutable('2023-12-31') // Modificado antes de
);

$links = Rebrandly::listLinks($filters);
```

### CreateTagData y UpdateTagData

[](#createtagdata-y-updatetagdata)

Para gestionar tags:

```
// Crear tag
$createTag = new CreateTagData(
    name: 'Marketing',      // Requerido
    color: '#ff6b35'        // Opcional - color hexadecimal
);

// Actualizar tag
$updateTag = new UpdateTagData(
    name: 'New Name',       // Opcional
    color: '#00ff00'        // Opcional
);
```

### TagData

[](#tagdata)

Información de un tag:

```
$tag = RebrandlyTags::getTag('tag123');

echo $tag->id;          // ID del tag
echo $tag->name;        // Nombre
echo $tag->color;       // Color (hex)
echo $tag->linksCount;  // Cantidad de enlaces asociados

// Para obtener los enlaces de un tag
$tagLinks = RebrandlyTags::getTagLinks($tag->id);
foreach ($tagLinks as $link) {
    echo $link->title . ' - ' . $link->clicks . ' clicks';
}
```

Casos de Uso Comunes
--------------------

[](#casos-de-uso-comunes)

### Gestión Completa de Tags y Enlaces

[](#gestión-completa-de-tags-y-enlaces)

```
// Crear un nuevo tag para una campaña
$campaignTag = RebrandlyTags::createTag(new CreateTagData(
    name: 'Black Friday 2024',
    color: '#000000'
));

// Crear varios enlaces para la campaña
$links = [
    'https://shop.com/deals/electronics',
    'https://shop.com/deals/clothing',
    'https://shop.com/deals/home'
];

$createdLinks = [];
foreach ($links as $index => $url) {
    $linkData = new CreateLinkData(
        destination: $url,
        slashtag: 'bf-deal-' . ($index + 1),
        title: 'Black Friday Deal ' . ($index + 1)
    );

    $link = Rebrandly::createLink($linkData);
    $createdLinks[] = $link;

    // Asociar el tag a cada enlace
    Rebrandly::attachTagToLink($link->id, $campaignTag->id);
}

// Obtener estadísticas de la campaña
$campaignLinks = RebrandlyTags::getTagLinks($campaignTag->id);
$totalClicks = array_sum(array_column($campaignLinks, 'clicks'));

echo "Campaña: {$campaignTag->name}";
echo "Total de enlaces: " . count($campaignLinks);
echo "Total de clicks: {$totalClicks}";
```

### Filtrado Avanzado de Enlaces

[](#filtrado-avanzado-de-enlaces)

```
// Buscar enlaces populares de los últimos 30 días
$filters = new LinkFilters(
    limit: 20,
    orderBy: 'clicks',
    orderDir: 'desc',
    favourite: true,
    createdAfter: new DateTimeImmutable('-30 days'),
    tags: ['marketing', 'social-media']
);

$popularLinks = Rebrandly::listLinks($filters);

// Mostrar estadísticas
foreach ($popularLinks as $link) {
    echo "{$link->title}: {$link->clicks} clicks - {$link->shortUrl}";
}
```

Gestión de Errores
------------------

[](#gestión-de-errores)

El paquete maneja automáticamente los errores de la API de Rebrandly:

```
use KemokRepos\Larabrandly\Exceptions\RebrandlyException;

try {
    $link = Rebrandly::createLink($createData);
} catch (RebrandlyException $e) {
    echo $e->getMessage();

    // Para errores de validación, obtén el contexto
    if ($e->getCode() === 422) {
        $errors = $e->getContext()['errors'] ?? [];
        // Manejar errores de validación
    }
}
```

Testing
-------

[](#testing)

```
# Ejecutar todas las pruebas
composer test

# Generar reporte de cobertura en HTML (requiere Xdebug o PCOV)
composer test-coverage

# Ver cobertura en la terminal (requiere Xdebug o PCOV)
composer test-coverage-text

# Generar archivo XML de cobertura para CI/CD (requiere Xdebug o PCOV)
composer test-coverage-clover
```

### Configurar Cobertura de Código

[](#configurar-cobertura-de-código)

Para generar reportes de cobertura, necesitas instalar **Xdebug** o **PCOV**:

#### Opción 1: Instalar Xdebug

[](#opción-1-instalar-xdebug)

```
# macOS (con Homebrew)
brew install php@8.1-xdebug  # o tu versión de PHP

# Ubuntu/Debian
sudo apt-get install php-xdebug

# CentOS/RHEL
sudo yum install php-xdebug
```

#### Opción 2: Instalar PCOV (más rápido para cobertura)

[](#opción-2-instalar-pcov-más-rápido-para-cobertura)

```
# Con PECL
pecl install pcov

# Agregar a php.ini
echo "extension=pcov.so" >> php.ini
```

Una vez instalado cualquiera de los dos, los comandos de cobertura funcionarán correctamente.

Análisis de Código
------------------

[](#análisis-de-código)

```
# Análisis estático con PHPStan
composer analyse
# o
composer phpstan

# Verificar formato del código
composer check-format

# Aplicar formato automáticamente
composer format

# Ejecutar todas las verificaciones de calidad
composer quality
```

Changelog
---------

[](#changelog)

Por favor consulta [CHANGELOG](CHANGELOG.md) para más información sobre los cambios recientes.

Contribuciones
--------------

[](#contribuciones)

Por favor consulta [CONTRIBUTING](CONTRIBUTING.md) para más detalles.

Seguridad
---------

[](#seguridad)

Si descubres algún problema de seguridad, por favor envía un email a  en lugar de usar el issue tracker.

Créditos
--------

[](#créditos)

- [Kemok Repos](https://github.com/kemok-repos)
- [Todos los Contribuidores](../../contributors)

Licencia
--------

[](#licencia)

La Licencia MIT (MIT). Por favor consulta [License File](LICENSE.md) para más información.

###  Health Score

29

—

LowBetter than 57% of packages

Maintenance54

Moderate activity, may be stable

Popularity2

Limited adoption so far

Community2

Small or concentrated contributor base

Maturity48

Maturing project, gaining track record

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

4

Last Release

305d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/60a2f0da7177cf4b726ce064944578c4fc2641e06f24afa759ad0a9a4e2714d6?d=identicon)[lgamez-kemok](/maintainers/lgamez-kemok)

---

Tags

apilaravelurl shortenerrebrandlyshort-links

###  Code Quality

Static AnalysisPHPStan

Code StylePHP CS Fixer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/kemok-repos-larabrandly/health.svg)

```
[![Health](https://phpackages.com/badges/kemok-repos-larabrandly/health.svg)](https://phpackages.com/packages/kemok-repos-larabrandly)
```

###  Alternatives

[dedoc/scramble

Automatic generation of API documentation for Laravel applications.

2.1k11.2M100](/packages/dedoc-scramble)[simplestats-io/laravel-client

Server-side analytics for Laravel that follows the full funnel from visit to registration to payment, attributed to the channel that drove it. Revenue, MRR, churn and ad-spend profit (ROAS/CAC) per channel. GDPR compliant, ad-blocker proof.

5021.9k](/packages/simplestats-io-laravel-client)[spatie/laravel-health

Monitor the health of a Laravel application

87512.0M165](/packages/spatie-laravel-health)[defstudio/telegraph

A laravel facade to interact with Telegram Bots

816333.8k3](/packages/defstudio-telegraph)[nativephp/mobile

NativePHP for Mobile

1.1k75.1k91](/packages/nativephp-mobile)[codebar-ag/laravel-docuware

DocuWare integration with Laravel

1123.7k](/packages/codebar-ag-laravel-docuware)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)