Download the PHP package archerzdip/laravel-api-auth without Composer
On this page you can find all versions of the php package archerzdip/laravel-api-auth. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download archerzdip/laravel-api-auth
More information about archerzdip/laravel-api-auth
Files in archerzdip/laravel-api-auth
Package laravel-api-auth
Short Description Authorize requests to your Laravel application with API keys
License MIT
Informations about the package laravel-api-auth
Laravel-api-auth
Installation
Run composer require archerzdip/laravel-api-auth
.
Publish the migration files
$ php artisan vendor:publish
# Or...
$ php artisan vendor:publish --provider="ArcherZdip\LaravelApiAuth\Providers\ApiAuthServiceProvider"
Run the migrations
$ php artisan migrate
Console
Generate a new app using php artisan apikey:generate {name}
. The name argument is the name of your APP name. All new app are active by default.
About app opreate, like activate, deactivate, delete, refresh secret.
Deactivate app by appid using php artisan apikey:put {appid} -F
Activate app by appid using php artisan apikey:put {appid} -A
Refresh secret by appid using php artisan apikey:put {appid} -R
Delete app by appid using php artisan apikey:put {appid} -D
List all app. The -D or --deleted flag includes deleted apps.
Usage
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 Authorization
header as part of the request, with its value being an active API key.
Authorization: VApUyoTm5I5DtlQAJjJbmCbrdceFsVCb6H3CpsL4SdUlgGdUui8WjxwbcejAfmL7
or token={token}
Token generate regulation.
Event history
Any time an API key is generated, activated, deactivated, or deleted, a record is logged in the api_auth_oprate_event
table. Each record contains the following information:
- app_client_id
- ip_address
- event
- created_at
- updated_at
API event history
If you open log, all API requests that pass authorization will logger. Support driver database and file. Database infomation:
- appid
- ip_address
- url
- params
- type
TODO
- Configuration way of encryption.
License
MIT license