Skip to content

adamlundrigan/LdcZfcUserApi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LdcZfcUserApi

What?

A REST API for ZfcUser, suitable for standalone use or in an Apigility application.

  • POST /user - Account registration
  • GET /user/:user_id - Retrieve user profile
  • PUT /user/:id/email - Update account email address
  • PUT /user/:id/password - Change account password

WARNING: This code is not yet tested, documented or been used in a live environment. Approach with extreme caution.

How?

  1. Install module using Composer

    composer install adamlundrigan/ldc-zfc-user-api:<version>
    
  2. Enable required modules in your application.config.php file:

    • ZfcBase
    • ZfcUser
    • LdcZfcUserApi
  3. Configure ZfcUser

Notes

Standalone mode

If you're using LdcZfcUserApi in lieu of ZfcUser's bundled frontend (eg: as part of an Apigility app) you will want to disable the routes which come pre-activated in ZfcUser. To do this, simply add the following lines to your application's config (f.e, to global.php):

    'ldc-zfc-user-api' => array(
        'nuke_zfcuser_routes' => true,
    ),

TODO

  • Apigility RPC resource for account registration
  • Apigility RPC resource for change email / change password
  • RBAC / ACL integration points
  • Some tests might be a good idea
  • Some documentation and an example might also be good ideas

About

A REST API for ZfcUser

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages