Download the PHP package baraja-core/structured-api-token-authorizator without Composer
On this page you can find all versions of the php package baraja-core/structured-api-token-authorizator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download baraja-core/structured-api-token-authorizator
More information about baraja-core/structured-api-token-authorizator
Files in baraja-core/structured-api-token-authorizator
Package structured-api-token-authorizator
Short Description A simple token authorizer for authenticating HTTP requests.
License
Homepage https://github.com/baraja-core/structured-api-token-authorizator
FAQ
Example:
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 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.
Informations about the package structured-api-token-authorizator
Structured API token authorizator
A simple token authorizer for authenticating HTTP requests.
This package is the official extension for the Baraja Structured API.
📦 Installation
It's best to use Composer for installation, and you can also find the package on Packagist and GitHub.
To install, simply use the command:
You can use the package manually by creating an instance of the internal classes, or register a DIC extension to link the services directly to the Nette Framework.
Simple usage
Install this package using Composer and register the DIC extension (if you use Baraja Package manager, it will be registered automatically).
Extension definition for manual usage:
The package automatically disables the default system method of authenticating requests through Nette User and will require token authentication.
A token is any valid string in the query parameter token, or in BODY (in the case of a POST request). The token evaluates as an endpoint call parameter and can be passed to the target endpoint as a string.
Request verification
If you are not using your own token authentication implementation, the default SimpleStrategy will be used, which you can configure the token via NEON configuration.
If you do not set a token, all requests (even without a token) will be considered valid.
Simple configuration example:
This configuration accepts requests as: /api/v1/user?token=abcd.
Token verification at the endpoint level
Token usage is verified at the endpoint level. By default, all endpoints have access enabled and are governed by the PublicEndpoint attribute defined by the baraja-core/structured-api package.
If you want to require token authentication in your endpoint, set the attribute directly above the endpoint definition.
For example:
Custom authentication
If you need more complex authentication logic, implement a service that implements the VerificationStrategy interface and register it with the DIC. This service will be called automatically when all requests are verified.
📄 License
baraja-core/structured-api-token-authorizator is licensed under the MIT license. See the LICENSE file for more details.
