Download the PHP package ipimpat/laravel-api-key without Composer

On this page you can find all versions of the php package ipimpat/laravel-api-key. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package laravel-api-key

Laravel API Key Auth

Total Downloads Latest Stable Version License

Installation

Run composer require ipimpat/laravel-api-key.

In your config/app.php file, add the Laravel API Key service provider to the end of the providers array.

Publish the migration files

$ php artisan vendor:publish

Run the migrations

$ php artisan migrate

3 new database tables will be created:

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

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:

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:

License

The Laravel API Key package is open-sourced software licensed under the MIT license.


All versions of laravel-api-key with dependencies

PHP Build Version
Package Version
Requires php Version >=5.5.9
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package ipimpat/laravel-api-key contains the following files

Loading the files please wait ....