yoctu/api-guardian

Protect your API with a token (objective-php)

API guardian

, _(*1)

Protect your pages with a token!, _(*2)

Prerequisites

You will need a project running Objective-PHP to use this package., _(*3)

If you want to use the user token feauture, you'll need a user with the attribute apiToken With yoctu/connect you'll need at least connect-common v2.2.3, _(*4)

Installing

The package should be easy to install. You just need to add this repository to your composer.json, _(*5)

composer require yoctu/api-guardian

And add the package to your Application.php with filter(s) if needed., _(*6)

$this->getStep('auth')
    ->plug(Apiguardian::class, new UrlFilter('/api/*'))->as('api-guardian')
;

Using the package

Now that the package has been plugged on your application you can setup the one or more token to be used in the configuration., _(*7)

return [
    new Param('api-keys', ['api_key_one', 'api_key_two'])
];

You'll now need to add a token to your request to pass the middleware, _(*8)

GET / HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate
Authorization: api_key_one
Connection: keep-alive

Running the tests

./vendor/bin/phpunit --bootstrap vendor/autoload.php tests, _(*9)

License

This project is licensed under the GNU GPL 3.0 License - see the LICENSE file for details, _(*10)