aplr/laravel-bouncer

There is no license information available for the latest version (v0.1.6) of this package.

Rigorously restricts access to your apis.

v0.1.6 2018-05-08 17:09 UTC

This package is auto-updated.

Last update: 2024-11-20 10:04:32 UTC


README

Introduction

The bouncer package enables you to restrict access to your apis using application keys.

Installation

Require the aplr/laravel-bouncer package in your composer.json and update your dependencies:

$ composer require aplr/laravel-bouncer

Usage

In order to check if requests to your api include a valid key, you can use the Bounce-middleware:

protected $middlewareGroups = [
    'web' => [
       // ...
    ],

    'api' => [
        // ...
        \Aplr\Bouncer\Bounce::class,
    ],
];

To generate a new key, simply use the following method:

use Aplr\Bodybuilder\Facades\Bouncer;

$key = Bouncer::createKey('My App');

You can manually check if a given key is valid by using the following method:

$valid = Bouncer::check('ZKEpwUSii5yvWt1xgLwHd8yguQGBZtrSi39hXFFd');