Download the PHP package vuetober/rainlab-user-api without Composer

On this page you can find all versions of the php package vuetober/rainlab-user-api. 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 vuetober/rainlab-user-api

Informations about the package rainlab-user-api

rainlab-user-api

Build status Code coverage Code style MIT License

A simple and extendable HTTP API for RainLab.User.

Installation & configuration

To install the API, run the following commands from your root October directory:

By default, all routes are grouped behind a /api/rainlab/user prefix. To override this, add the following to a .env file at the root of your October installation. Alternatively, you can use October's file based configuration.

To disable the API completely, add the following environment variable:

Basic usage

To get the authenticated user, use the AccountManager class.

Using this method to fetch the User model will trigger a bedard.rainlabuserapi.afterGetUser event. This can be useful when other data is needed with the user. As an example, here we'll configure the API to load the user's avatar.

Adding Middleware

All endpoints use a base controller that can be extended. This can be used to add middleware that make the responses consistent with the rest of your API. To do this, add the following to your Plugin.php file. See the October documentation for more information on using middleware.

Endpoints

POST: /api/rainlab/user/auth/login

Authenticate a user.

ANY: /api/rainlab/user/auth/logout

Log out the authenticated user.

ANY: /api/rainlab/user/auth/stop-impersonation

Stop impersonating a user.

POST: /api/rainlab/user/users

Create user and trigger activation process.

GET: /api/rainlab/user/users/activate/{code}

Activate a new user.

POST: /api/rainlab/user/users/forgot-password

Send the user a link to reset their password.

POST: /api/rainlab/user/users/reset-password

Reset a user's password.

GET: /api/rainlab/user/account

Get information about the authenticated user. This route uses the AuthMiddleware, authentication is required to access it.

POST: /api/rainlab/user/account

Updates information about the authenticated user. This route uses the AuthMiddleware, authentication is required to access it. When changing passwords with safe password updates enabled, the user's current password must be included in the request as password_current.

DELETE: /api/rainlab/user/account/avatar

Deletes the authenticated user's avatar. This route uses the AuthMiddleware, authentication is required to access it.

License

MIT

Copyright (c) 2018-present, Scott Bedard.

All versions of rainlab-user-api with dependencies

PHP Build Version
Package Version
No informations.
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 vuetober/rainlab-user-api contains the following files

Loading the files please wait ....