Since this version is a fork, load the package with composer as a VCS repository.
Run composer config repositories.stillatmylinux vcs https://github.com/stillatmylinux/laravel-api-key.git
Run composer require stillatmylinux/laravel-api-key:dev-master
Composer will auto discover the ApiKeyServiceProvider. However, if it does not, in your config/app.php
file, add the Laravel API Key service provider to the end of the providers
array.
'providers' => [
...
Ejarnutowski\LaravelApiKey\Providers\ApiKeyServiceProvider::class,
],
Publish the migration and config files
$ php artisan vendor:publish
If you want to use a secret key with your API, open config/apikey.php
and modify the enable_secret_key option.
return array(
'enable_secret_key' => true,
);
Run the migrations
$ php artisan migrate
3 new database tables will be created:
- api_keys
- api_key_access_events
- api_key_admin_events
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
// Secret: HOvMgMDQ256jybfFokYt1kAokxtxXEA0mgyTbRQY4iPxzthaPtPj3CrUrxJ9uadP
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 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 |
// +----------+----+-------------+---------------------+------------------------------------------------------------------+
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
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');
}
}
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
X-Authorization-Secret: HOvMgMDQ256jybfFokYt1kAokxtxXEA0mgyTbRQY4iPxzthaPtPj3CrUrxJ9uadP
Requests that do not pass authorization will receive an HTTP 401 Status Code with the following response
{
"errors": [
{
"message": "Unauthorized"
}
]
}
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
The Laravel API Key package is open-sourced software licensed under the MIT license.