Add API Keys to Your Laravel Models with Laravel Keyable

Published on by

Add API Keys to Your Laravel Models with Laravel Keyable image

Laravel Keyable is a package by Liran Cohen that enables you to add API keys to any model and associate incoming requests with their respective model. You can also use Policies to authorize requests.

This package works by adding a Keyable trait to a given model (i.e., Company model) that creates a polymorphic association between a model and an API key:

use Illuminate\Database\Eloquent\Model;
use Givebutter\LaravelKeyable\Keyable;
 
class Account extends Model
{
use Keyable;
 
// ...
}

Using a middleware that the package provides, a token will be validated via a configurable strategy comprised of a bearer token, a custom header (i.e., X-Authorization), or a query param.

After validation, you configure a policy and check for authorization in the controller like this, for example:

<?php
 
namespace App\Http\Controllers\PostController;
 
use App\Models\Post;
use Illuminate\Http\Request;
use App\Http\Controllers\Controller;
use Givebutter\LaravelKeyable\Auth\AuthorizesKeyableRequests;
 
class PostController extends Controller {
use AuthorizesKeyableRequests;
 
public function show(Post $post) {
$this->authorizeKeyable('view', $post);
// ...
}
}

In the controller, you can further scope your queries based on the “keyable” model that is added to the request object:

$model = $request->keyable;
 
// Example of scoping the API resource
$model->foo()->get();

Last, you can use a provided artisan command to create an API key for a given model:

php artisan api-key:generate --id=1 --type="App\Models\Account"

You can learn more about this package, get full installation instructions, and view the source code on GitHub at givebutter/laravel-keyable.

Paul Redmond photo

Staff writer at Laravel News. Full stack web developer and author.

Filed in:
Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

image
Laravel Forge

Easily create and manage your servers and deploy your Laravel applications in seconds.

Visit Laravel Forge
Laravel Forge logo

Laravel Forge

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Forge
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
No Compromises logo

No Compromises

Joel and Aaron, the two seasoned devs from the No Compromises podcast, are now available to hire for your Laravel project. ⬧ Flat rate of $7500/mo. ⬧ No lengthy sales process. ⬧ No contracts. ⬧ 100% money back guarantee.

No Compromises
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
LoadForge logo

LoadForge

Easy, affordable load testing and stress tests for websites, APIs and databases.

LoadForge
Paragraph logo

Paragraph

Manage your Laravel app as if it was a CMS – edit any text on any page or in any email without touching Blade or language files.

Paragraph
Lucky Media logo

Lucky Media

Bespoke software solutions built for your business. We ♥ Laravel

Lucky Media
Lunar: Laravel E-Commerce logo

Lunar: Laravel E-Commerce

E-Commerce for Laravel. An open-source package that brings the power of modern headless e-commerce functionality to Laravel.

Lunar: Laravel E-Commerce
Bacancy - Staff Augmentation logo

Bacancy - Staff Augmentation

Leave your web app development hustles to the leading IT Staff Augmentation Service Providers. Choose from an extensive pool of 1050+ developers and give yourself the sigh of success you deserve with Bacancy. Get In Touch Today!

Bacancy - Staff Augmentation
DocuWriter.ai logo

DocuWriter.ai

Save hours of manually writing Code Documentation, Comments & DocBlocks, Test suites and Refactoring.

DocuWriter.ai
Rector logo

Rector

Your partner for seamless Laravel upgrades, cutting costs, and accelerating innovation for successful companies

Rector

The latest

View all →
Add Architecture Tests to Saloon API Integrations with Lawman image

Add Architecture Tests to Saloon API Integrations with Lawman

Read article
Protect Routes with JWT Tokens Using This Package for Laravel image

Protect Routes with JWT Tokens Using This Package for Laravel

Read article
Increment a Rate Limiter by a Custom Amount in Laravel 10.46 image

Increment a Rate Limiter by a Custom Amount in Laravel 10.46

Read article
Add Kanban Boards to Your Laravel App in Seconds image

Add Kanban Boards to Your Laravel App in Seconds

Read article
October CMS v3.6 Ships Today, Full of New Features image

October CMS v3.6 Ships Today, Full of New Features

Read article
Laracon EU Videos are now out image

Laracon EU Videos are now out

Read article