Download the PHP package uogsoe/basic-api-token-middleware without Composer
On this page you can find all versions of the php package uogsoe/basic-api-token-middleware. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download uogsoe/basic-api-token-middleware
More information about uogsoe/basic-api-token-middleware
Files in uogsoe/basic-api-token-middleware
Package basic-api-token-middleware
Short Description Very basic API key middleware for Laravel
License MIT
Informations about the package basic-api-token-middleware
Basic API key middleware for Laravel
This is a simple key-based middleware for Laravel. It suited our common use-case of internal apps which need access to other internal apps (machine-to-machine) without the hassles of oauth etc.
Installation
You should be able to pull it in using composer :
Then you have to publish the database migration and ApiKey model :
And pick UoGSoE\ApiTokenMiddleware\ApiTokenServiceProvider
from the list. Then run the migration :
Usage
First of all you create a token for the consuming 'service' (eg, the remote client) :
That will create the token and show it to you. You need to take note of the token as your client will have to use it to access the routes.
Now in your routes/api.php
file you can use the middleware to wrap endpoints :
If you try and access that route without passing the token you will get a 401 response :
So pass the token you created above and it should let you through :
You can pass the token in various ways, like a GET param as above, a bearer token header or as part of the JSON body. Eg:
You can use multiple service token names with a route if you want to seperate your api controls too :
There are a few other artisan commands available to help manage the tokens :