Download the PHP package ohffs/simple-api-key-middleware without Composer

On this page you can find all versions of the php package ohffs/simple-api-key-middleware. 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?

Example code of ohffs/simple-api-key-middleware

Informations about the package simple-api-key-middleware

Simple API key middleware for Laravel

This is a very basic middleware to check a bearer token on an incoming request.

Installation

The migration will create a new database table called simple_api_keys. You can have a look in the packages migrations/ directory to see the details.

Usage

The package registers a middleware alias simple-api-key (mapped to \Ohffs\SimpleApiKeyMiddleware\ApiKeyMiddleware). To protect a given route you could do :

See the Laravel docs for more examples such as route groups or default middlewares.

To generate an API key from the CLI you can use the artisan command :

Which will create the key with that description and show you the resulting token. You can remove a key by doing :

(where the 14-2398... is the token you generated). You can also programmatically create a token :

The plaintext_token is only available on freshly created tokens.

To make a request using the token, you pass it as a regular bearer-token. Eg, with curl :

Or using Laravel's HTTP client :

Configuration

The default configuration is as follows :

You can set those environment variables, or if you run php artisan vendor:publish and pick the config from this package you can edit the resulting config/simple_api_keys.php file. By default the middleware will cache token lookups to save hitting the database for every one. If you are not using a cache such as Redis then you might want to disable the caching.

All versions of simple-api-key-middleware with dependencies

PHP Build Version
Package Version
Requires illuminate/http Version ^9.5
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 ohffs/simple-api-key-middleware contains the following files

Loading the files please wait ....