PHPackages hypesewa/access-api-key - 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. [Authentication & Authorization](/categories/authentication) 4. / 5. hypesewa/access-api-key ActiveLibrary[Authentication & Authorization](/categories/authentication) hypesewa/access-api-key ======================= Authorize requests to hypesewa service with API keys 1.0.0(3y ago)013MITPHPPHP >=8.0.0 Since Dec 21Pushed 3y ago1 watchersCompare [ Source](https://github.com/roshan059/hype-package-api-access-key)[ Packagist](https://packagist.org/packages/hypesewa/access-api-key)[ RSS](/packages/hypesewa-access-api-key/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (1)Dependencies (2)Versions (2)Used By (0) Laravel API Key Auth ==================== [](#laravel-api-key-auth) Installation ------------ [](#installation) Run `composer require hypesewa/access-api-key`. In your `bootstrap/app.php` file, add the Laravel API Key service provider to the end of the `providers` array. ``` $app->register(\Hypesewa\AccessApiKey\Providers\ApiKeyServiceProvider::class); ``` Publish the migration files ``` $ php artisan vendor:publish ``` Run the migrations ``` $ php artisan migrate ``` 3 new database tables will be created: - api\_keys - api\_key\_access\_events - api\_key\_admin\_events Managing 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. ``` $ php artisan apikey:generate app1 // API key created // Name: app1 // Key: 0ZdNlr7LrQocaqz74k6usQsOsqhqSIaUarSTf8mxnHuQVh9CvKAfpUy94VvBmFMq ``` Deactivate a key using `php artisan apikey:deactivate {name}`. ``` $ php artisan apikey:deactivate app1 // Deactivated key: app1 ``` Activate a key using `php artisan apikey:activate {name}`. ``` $ php artisan apikey:activate app1 // Activated key: app1 ``` Delete a key. You'll be asked to confirm. Keys are [soft-deleted](https://laravel.com/docs/eloquent#soft-deleting) for record keeping. ``` $ php artisan apikey:delete app1 // Are you sure you want to delete API key 'app1'? (yes/no) [no]: // > yes // Deleted key: app1 ``` List all keys. The -D or --deleted flag includes deleted keys ``` $ php artisan apikey:list -D // +----------+----+-------------+---------------------+------------------------------------------------------------------+ // | Name | ID | Status | Status Date | Key | // +----------+----+-------------+---------------------+------------------------------------------------------------------+ // | app1 | 5 | deleted | 2017-11-03 13:54:51 | 0ZdNlr7LrQocaqz74k6usQsOsqhqSIaUarSTf8mxnHuQVh9CvKAfpUy94VvBmFMq | // | app2 | 1 | deleted | 2017-11-02 22:34:28 | KuKMQbgZPv0PRC6GqCMlDQ7fgdamsVY75FrQvHfoIbw4gBaG5UX0wfk6dugKxrtW | // | app3 | 3 | deactivated | 2017-11-02 23:12:34 | IrDlc7rSCvUzpZpW8jfhWaH235vJAqFwyzVWpoD0SLGzOimA6hcwqMvy4Nz6Hntn | // | app4 | 2 | active | 2017-11-02 22:48:13 | KZEl4Y2HMuL013xvg6Teaa7zHPJhGy1TDhr2zWzlQCqTxqTzyPTcOV6fIQZVTIU3 | // +----------+----+-------------+---------------------+------------------------------------------------------------------+ ``` Usage ----- [](#usage) ### Implementing Authorization [](#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](https://laravel.com/docs/middleware) in the Laravel Docs. Route example ``` Route::get('api/user/1', function () { // })->middleware('auth.apikey'); ``` Controller example ``` class UserController extends Controller { /** * Instantiate a new controller instance. * * @return void */ public function __construct() { $this->middleware('auth.apikey'); } } ``` ### Authorizing Requests [](#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 --------------------- [](#unauthorized-requests) Requests that do not pass authorization will receive an HTTP 401 Status Code with the following response ``` { "errors": [ { "message": "Unauthorized" } ] } ``` Event History ------------- [](#event-history) All API requests that pass authorization are logged in the `api_key_access_events` table. A record is created for each request with the following information: - api\_key\_id - ip\_address - url - created\_at - updated\_at Any time an API key is generated, activated, deactivated, or deleted, a record is logged in the `api_key_admin_events` table. Each record contains the following information: - api\_key\_id - ip\_address - event - created\_at - updated\_at License ------- [](#license) The Laravel API Key package is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT). ### Health Score 23 — LowBetter than 27% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity5 Limited adoption so far Community7 Small or concentrated contributor base Maturity51 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure 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 Unknown Total 1 Last Release 1242d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/81e3217afe5646de8c3fc8aec159ce11b2614069208b1cc407cf976a1814b585?d=identicon)[roshan059](/maintainers/roshan059) --- Top Contributors [![roshanmav](https://avatars.githubusercontent.com/u/132442112?v=4)](https://github.com/roshanmav "roshanmav (3 commits)") --- Tags apiAuthenticationlumenauthorizationapi-key ### Embed Badge ![Health badge](/badges/hypesewa-access-api-key/health.svg) ``` [![Health](https://phpackages.com/badges/hypesewa-access-api-key/health.svg)](https://phpackages.com/packages/hypesewa-access-api-key) ``` ### Alternatives [league/oauth2-server A lightweight and powerful OAuth 2.0 authorization and resource server library with support for all the core specification grants. This library will allow you to secure your API with OAuth and allow your applications users to approve apps that want to access their data from your API. 6.6k136.0M248](/packages/league-oauth2-server)[auth0/auth0-php PHP SDK for Auth0 Authentication and Management APIs. 40820.2M68](/packages/auth0-auth0-php)[auth0/login Auth0 Laravel SDK. Straight-forward and tested methods for implementing authentication, and accessing Auth0's Management API endpoints. 2745.0M3](/packages/auth0-login)[ejarnutowski/laravel-api-key Authorize requests to your Laravel application with API keys 157441.1k1](/packages/ejarnutowski-laravel-api-key)[auth0/symfony Symfony SDK for Auth0 Authentication and Management APIs. 128738.1k](/packages/auth0-symfony)[hasinhayder/tyro Tyro - The ultimate Authentication, Authorization, and Role & Privilege Management solution for Laravel 12 & 13 6712.1k2](/packages/hasinhayder-tyro) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)