Saltar al contenido principal

Laravel SDK

SDK para verificar tokens de fila virtual en proyectos Laravel.

Instalación​

Instalación en Laravel​

  1. Agregar el paquete a tu proyecto Laravel:

    composer require virtual-queue/token-verifier-laravel

  2. Publicar el archivo de configuración:

    php artisan vendor:publish --provider="VirtualQueue\TokenVerifier\Laravel\TokenVerifierServiceProvider" --tag="config"

  3. Configurar las variables de entorno en tu archivo .env:

    VIRTUAL_QUEUE_BASE_URL=https://app.virtual-queue.com
    VIRTUAL_QUEUE_TIMEOUT=30

Uso en Laravel​

Podés usar el SDK en tus controladores de Laravel de dos maneras: mediante inyección de dependencias o utilizando el Facade.

Inyección de dependencias​

use VirtualQueue\TokenVerifier\TokenVerifier;

class YourController extends Controller
{
    protected $tokenVerifier;

    public function __construct(TokenVerifier $tokenVerifier)
    {
        $this->tokenVerifier = $tokenVerifier;
    }

    public function verify($request)
    {
        if($request->token) {
            // For details about the queue:
            $result = $this->tokenVerifier->verifyToken($token);
            // [
            //      'success' => true,
            //      'data' => [
            //           'token': 'f1a10b71-f37d-499f-b30d-7542a7b4f5db',
            //           'finished_line': [
            //               'finished_at': '2024-09-17T09:47:10Z',
            //               'ingressed_at': '2024-09-17T09:15:53Z'
            //       ]
            // ]

            // For true/false
            $result = $this->tokenVerifier->isTokenValid($token);
            // true | false

            //Return error or redirect if token is invalid...
        }

        //Rest of the logic
    }
}

Uso del Facade​

use VirtualQueue\TokenVerifier\Laravel\Facades\TokenVerifier;

class YourController extends Controller
{
    public function verify($request)
    {
        if($request->token) {
            // For details about the queue:
            $result = $this->tokenVerifier->verifyToken($token);
            // [
            //      'success' => true,
            //      'data' => [
            //           'token': 'f1a10b71-f37d-499f-b30d-7542a7b4f5db',
            //           'finished_line': [
            //               'finished_at': '2024-09-17T09:47:10Z',
            //               'ingressed_at': '2024-09-17T09:15:53Z'
            //       ]
            // ]

            // For true/false
            $result = $this->tokenVerifier->isTokenValid($token);
            // true | false

            //Return error or redirect if token is invalid...
        }

        //Rest of the logic
    }
}

Métodos disponibles​

verifyToken(string $token): array​

Verifica un token y devuelve los datos asociados si es válido.

isTokenValid(string $token): bool​

Verifica si un token es válido (devuelve true o false).

Licencia​

MIT