Download the PHP package cable8mm/auth-by-key without Composer
On this page you can find all versions of the php package cable8mm/auth-by-key. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download cable8mm/auth-by-key
More information about cable8mm/auth-by-key
Files in cable8mm/auth-by-key
Package auth-by-key
Short Description Authorize requests to your Laravel application with API keys
License MIT
Informations about the package auth-by-key
Auth By Key
We are also able to use Laravel's first-party libraries for authorization, but it might not be lightweight. Yes, as a user Eloquent model, this can help with the problem. Only requests that pass through the 'auth-by-key' layer can proceed to the next stage through Laravel request.
We have provided the API Documentation on the web. For more information, please visit https://www.palgle.com/auth-by-key/ ❤️
Installation
Run composer require cable8mm/auth-by-key
.
Run the migrations
$ php artisan migrate
1 new database tables will be created:
- api_keys
Managing Keys
Generate a new key using php artisan apikey:generate {name}
. The name argument is the name of your API key. All new keys are active by default.
Deactivate a key using php artisan apikey:deactivate {name}
.
Activate a key using php artisan apikey:activate {name}
.
Delete a key. You'll be asked to confirm. Keys are soft-deleted for record keeping.
List all keys. The -D or --deleted flag includes deleted keys
Usage
Implementing Authorization
A new auth.apikey
route middleware has been registered for you to use in your routes or controllers. Below are examples on how to use middleware, but for detailed information, check out Middleware in the Laravel Docs.
Route example
Controller example
Authorizing Requests
In order to pass the auth.apikey
middleware, requests must include an X-Authorization
header as part of the request, with its value being an active API key.
X-Authorization: KuKMQbgZPv0PRC6GqCMlDQ7fgdamsVY75FrQvHfoIbw4gBaG5UX0wfk6dugKxrtW
Unauthorized Requests
Requests that do not pass authorization will receive an HTTP 401 Status Code with the following response
Laravel Nova
Publish the nova resource file
If you will typically need to overwrite,
Fix coding style
Test
License
The Auth By Key package is open-sourced software licensed under the MIT license.
All versions of auth-by-key with dependencies
illuminate/console Version ^9.18|^10.0
illuminate/database Version ^9.18|^10.0
illuminate/http Version ^9.18|^10.0
illuminate/routing Version ^9.18|^10.0
laravel/helpers Version ^1.1.0