json-api-auth / readme.txt

readme.txt in JSON API Auth 2.0.0, at readme.txt

187 lines 5.3 KB

Raw Download Zip

1
2	=== JSON API Auth ===
3
4	Donate link: http://www.parorrey.com
5	Tags: json api, api, authenticate user, wordpress user authentication
6	Contributors: parorrey
7	Stable tag: 2.0.0
8	Requires at least: 3.0.1
9	Tested up to: 5.0.0
10	Requires PHP: 5.3
11	License: GPLv2 or later
12
13	License URI: http://www.gnu.org/licenses/gpl-2.0.html
14
15	Extends the JSON API Plugin for RESTful user authentication
16
17	== Description ==
18
19	JSON API Auth extends the JSON API Plugin to allow RESTful user authentication.
20
21
22	Features include:
23
24	* Generate Auth Cookie for user authentication
25
26	* Validate Auth Cookie
27
28	* Get Current User Info
29
30	For documentation: See 'Other Notes' tab above for usage examples.
31
32	Credits: http://www.parorrey.com/solutions/json-api-auth/
33
34	== Installation ==
35
36	First you have to install the JSON API for WordPress Plugin (http://wordpress.org/extend/plugins/json-api/installation/).
37
38	To install JSON API Auth just follow these steps:
39
40	* upload the folder "json-api-auth" to your WordPress plugin folder (/wp-content/plugins)
41
42	* activate the plugin through the 'Plugins' menu in WordPress or by using the link provided by the plugin installer
43
44	* activate the controller through the JSON API menu found in the WordPress admin center (Settings -> JSON API)
45
46	== Screenshots ==
47
48	1. Call to generate_auth_cookie endpoint using Postman
49	2. Call to get_currentuserinfo endpoint using Postman
50	3. Call to validate_auth_cookie endpoint using Postman
51
52	== Changelog ==
53
54	= 2.0.0 =
55
56	* Updated for wordpress version
57
58	= 1.9.4 =
59
60	* Updated logo and header.
61
62	= 1.9.3 =
63
64	* Added minimum php version requirement.
65
66	= 1.9.2 =
67
68	* Added icons, screenshots, & fixed plugin header.
69
70	= 1.9.1 =
71
72	* Updated for WordPress 4.9.8 version.
73
74	= 1.9 =
75
76	* Updated for WordPress 4.9 version.
77
78
79	= 1.8 =
80
81	* Updated for WordPress 4.4 version. Made it secure by adding SSL check and adding POST method support, thanks to 'xiffy' for sharing code.
82
83	= 1.7 =
84
85	* updated for wordpress 4.1.2 version
86
87	= 1.6 =
88
89	* generate_auth_cookie does not require nonce any more to generate cookie.
90	* generate_auth_cookie now also returns 'cookie_name'.
91
92	= 1.5.1 =
93
94	* Fixed the JSON API Plugin link with protocol
95	* Updated notes for documentation.
96
97
98	= 1.5 =
99
100	* Added the function to authenticate, allow the user (with edit rights) to use JSON API core controllers as well. Thanks `necro_txilok` for the suggestion.
101	* Removed `clear_auth_cookie` for not doing what it intends to do, instead `generate_auth_cookie` has been modified to allow setting up auth cookie for any required duration. Just provide the `seconds` var with `nonce`, `username` and `password` to get required cookie. Default time is 14 days.
102	* Fixed typos in documentation.
103
104	= 1.4 =
105
106	* update for WordPress 4.1
107
108	= 1.3 =
109
110	* Removed bug for generating cookie
111
112
113	= 1.2 =
114
115	* Updated plugin description, documentation and few urls
116
117	= 1.1 =
118
119	* Added clear_auth_cookie() for removing auth cookie.
120
121	* Added documentation for the available end points
122
123
124	= 1.0 =
125
126	* Added the user avatar info for generate_auth_cookie() and get_currentuserinfo()
127
128
129	* Updated the FAQs
130
131	= 0.1 =
132
133	* Initial release.
134
135
136
137	== Upgrade Notice ==
138
139	= 0.1 =
140
141	* Initial release.
142
143
144	== Frequently Asked Questions ==
145
146	Thanks to 'mattberg' who wrote the auth controller (https://github.com/mattberg/wp-json-api-auth) initially. I have added few methods and authored it as a WordPress plugin so that it could easily be searched and installed vis WordPress.
147
148	* There are following methods available: validate_auth_cookie, generate_auth_cookie, clear_auth_cookie, get_currentuserinfo
149
150	* nonce can be created by calling http://localhost/api/get_nonce/?controller=auth&method=generate_auth_cookie
151
152	* You can then use 'nonce' value to generate cookie. http://localhost/api/auth/generate_auth_cookie/?nonce=f4320f4a67&username=Catherine&password=password-here
153
154	* Use cookie like this with your other controller calls: http://localhost/api/contoller-name/method-name/?cookie=Catherine\|1392018917\|3ad7b9f1c5c2cccb569c8a82119ca4fd
155
156	For instance, you have a new controller 'events' and want to allow users to post new 'event' using 'add_event' method.
157	This is how you will call the end point with cookie and post the event with user info:
158
159	http://localhost/api/events/add_event/?cookie=Catherine\|1392018917\|3ad7b9f1c5c2cccb569c8a82119ca4fd
160
161	If you want sample code how it can be done, check 'JSON API User' plugin https://wordpress.org/plugins/json-api-user/. This Auth plugin is part of JSON API User plugin.
162
163	= Method: validate_auth_cookie =
164
165	It needs 'cookie' var.
166
167	http://localhost/api/auth/validate_auth_cookie/?cookie=Catherine\|1392018917\|3ad7b9f1c5c2cccb569c8a82119ca4fd
168
169
170	= Method: generate_auth_cookie =
171
172	It needs `username`, `password` vars. `seconds` is optional.
173
174	Then generate cookie: http://localhost/api/auth/generate_auth_cookie/?username=john&password=PASSWORD-HERE
175
176	Optional 'seconds' var. It provided, generated cookie will be valid for that many seconds, otherwise default is for 14 days.
177
178	generate cookie for 1 minute: http://localhost/api/auth/generate_auth_cookie/?username=john&password=PASSWORD-HERE&seconds=60
179
180	60 means 1 minute.
181
182
183	= Method: get_currentuserinfo =
184
185	It needs 'cookie' var.
186
187	http://localhost/api/auth/get_currentuserinfo/?cookie=Catherine\|1392018917\|3ad7b9f1c5c2cccb569c8a82119ca4fd