Skip to content

Initial Improved Documentation #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -213,3 +213,6 @@ pip-log.txt

#Mr Developer
.mr.developer.cfg

#Documentation
formatting.md
48 changes: 30 additions & 18 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,24 @@
=== JSON API User ===

Donate link: <http://www.parorrey.com/solutions/json-api-user-plus/>
Tags: json api, RESTful user registration, authentication, RESTful Facebook Login, RESTful User Meta and BuddyPress xProfile
Contributors: parorrey
Stable tag: 3.0.0
Requires at least: 3.0.1
Tested up to: 5.0.0
Requires PHP: 5.3
License: GPLv2 or later
License URI: <http://www.gnu.org/licenses/gpl-2.0.html>
# JSON API User

## Overview

Extends the JSON API Plugin to allow RESTful user registration, authentication and many other User Meta, BuddyPress functions. A Pro version is also available.

==Description==
#### Donate link:
<http://www.parorrey.com/solutions/json-api-user-plus/>

Label | Details
------------ | -------------
Contributors: | parorrey, BHRIV (docs)
Stable tag | 3.0.0
Requires at least | 3.0.1
Tested up to | 5.0.0
Requires PHP | 5.3
License | GPLv2 or later
License URI | <http://www.gnu.org/licenses/gpl-2.0.html>


## Description

JSON API User extends the JSON API Plugin with a new Controller to allow RESTful user registration, authentication, password reset, RESTful Facebook Login, RESTful User Meta and BuddyPress xProfile get and update methods. This plugin is for WordPress/Mobile app developers who want to use WordPress as mobile app data backend.

Expand All @@ -37,13 +43,12 @@ My other JSON API Auth plugin has also been integrated with this from version 1.

Hope this will help some.

Pro Version - JSON API User Plus

A pro version of this plugin, JSON API User Plus, is available here <http://www.parorrey.com/solutions/json-api-user-plus/> that supports BuddyPress Messages component, BuddyPress avatar upload and other BuddyPress related functions to integrate BuddyPress features in your mobile app via REST.
#### Pro Version - JSON API User Plus

A pro version of this plugin, [JSON API User Plus](http://www.parorrey.com/solutions/json-api-user-plus/) supports BuddyPress Messages component, BuddyPress avatar upload and other BuddyPress related functions to integrate BuddyPress features in your mobile app via REST.
'JSON API User Plus' includes API key which protects and restricts the endpoint calls. This key can be updated from Settings &gt; User Plus options page. Your app must include this key with every call to get the data from REST API. Please see documentation for calling endpoints examples for 'JSON API User Plus'.

JSON API User Plus features include:
#### JSON API User Plus features include:

- Generate Auth Cookie for user authentication
- Validate Auth Cookie
Expand All @@ -67,7 +72,7 @@ JSON API User Plus features include:
- BuddyPress Settings
- & many more

== Installation ==
## Installation

First you have to install the JSON API for WordPress Plugin (<http://wordpress.org/extend/plugins/json-api/installation/>).

Expand All @@ -83,7 +88,14 @@ To install JSON API User just follow these steps:
2. Call to get\_currentuserinfo endpoint using Postman
3. Call to validate\_auth\_cookie endpoint using Postman

== Changelog ==


##### Tags:
json api, RESTful user registration, authentication, RESTful Facebook Login, RESTful User Meta and BuddyPress xProfile



### Changelog

= 3.0.0 =

Expand Down