mr_speer

WerkPress

As more and more developers turn towards front-end apps and data solutions, a solid AJAX API is key to developing 
a responsive, usable system of querying and modifying posts. While many solutions and plugins exist to help set up 
endpoints, often times they are cumbersome or overly opinionated. Simple Posts API provides your site with an easy-to-use, 
structure RESTful API with which to query, update, and delete posts. It is relatively unopinionated, so you can store and retrieve 
post metadata at will without worrying about setting up fields beforehand. Additionally, it employs native WordPress Nonces 
to provide a secure structure for updating your post data.
<h3>API Endpoints</h3>
<h4>Usage</h4>
There are four main operations you can use with this plugin:
<ul>
<li>Get</li>
<li>Put</li>
<li>Delete</li>
<li>Post</li>
</ul>
Each operation can be accessed by visiting <code>http://yoururl.com/postsapi/OPERATION/POST_TYPE||ID</code> You may pass a Post Type or ID as the second URL parameter depending on the operation you’re performing.
Each call must have a POST body containing a variable (nonce) containing a nonce value which WordPress will verify. There is a localized JS variable provided named <code>secure</code> which should be used. Some calls also allow other POST fields to be sent along with the call.
For calls which include Field data, the plugin will automatically determine which are Custom Fields and which are not.
See below for specifics on each operation.
<h4>GET</h4>
Retrieve a list of posts based on a provided Post Type or Post ID.
URL Path
<pre><code>http://yoururl.com/postsapi/get/POST_TYPE
</code></pre>
OR
<pre><code>http://yoururl.com/postapi/get/ID
</code></pre>
POST Body
Required:
<ul>
<li>nonce (nonce value for security)</li>
</ul>
Optional:
<ul>
<li>arguments (an array of get_post arguments to use in the call)</li>
</ul>
Example POST body:
<pre><code>jQuery.post( '/postsapi/get/post', { nonce: secure, arguments : {'posts_per_page': '-1'} })
 .done(function( data ) {
 console.log(data);
});
</code></pre>
Additional Notes:
The GET function returns author information for each post. If a user is logged in and has admin capabilities, the author information is extensive. If the user is not an admin, then any private information is stripped from the returned object for security purposes.
<h4>PUT</h4>
Update a post based on the provided ID and POSTed fields
URL Path
<pre><code>http://yoururl.com/postapi/put/ID
</code></pre>
POST Body
Required:
<ul>
<li>nonce (nonce value for security)</li>
<li>fields (an array of key:value pairs to determine which fields to update)</li>
</ul>
Optional:
<ul>
<li>force (boolean; if set to <code>false</code>, the call will return an error if any invalid field names are passed, otherwise it will update all valid fields regardless. Default is ‘false’)</li>
</ul>
Example POST body:
<pre><code>jQuery.post( '/postsapi/put/1', { nonce: secure, force: false, fields: { 'post_title': 'Updated Title', 'custom_text': 'Updated custom text' } } )
.done(function( data ) {
 console.log( data );
});
</code></pre>
<h4>DELETE</h4>
Delete a post based on the provided ID
URL Path
<pre><code>http://yoururl.com/postapi/delete/ID
</code></pre>
POST Body
Required:
<ul>
<li>nonce (nonce value for security)</li>
</ul>
Optional:
<ul>
<li>force (boolean; if set to <code>false</code>, the post will be sent to the trash, otherwise it will skip the trash and be permanently deleted. Default is ‘false’)</li>
</ul>
Example POST body:
<pre><code>jQuery.post( '/postsapi/delete/7', { nonce: secure, force: false } )
.done(function( data ) {
 console.log( data );
});
</code></pre>
<h4>POST</h4>
Create a post of the given post type, including the provided fields
URL Path
<pre><code>http://yoururl.com/postapi/post/POST_TYPE
</code></pre>
POST Body
Required:
<ul>
<li>nonce (nonce value for security)</li>
<li>fields (an array of key:value pairs to determine which fields to include when creating the post)</li>
</ul>
Optional:
<ul>
<li>none</li>
</ul>
Example POST body:
<pre><code>jQuery.post( '/postsapi/post/post', { nonce: secure, fields: { 'post_title': 'New Title', 'custom_text': 'New custom text', 'post_status': 'publish' } } )
.done(function( data ) {
 console.log( data );
});
</code></pre>
<h4>Errors and Status Messages</h4>
Each call will return a JSON object. Within the JSON object is a key named <code>status</code>. This contains a status code and status message. You can check against this in your scripts in order to see if the call was successful or not. Any status code other than 200 is an error.
<h4>Status Codes</h4>
<ul>
<li>200: Success</li>
<li>400: No posts found</li>
<li>401: Permission Denied (either failed the nonce verification or user not logged in)</li>
<li>410: Invalid Post ID or Post Type provided</li>
<li>420: Post ID not found</li>
<li>430: Fields not found (status message lists fields)</li>
<li>450: Post delete failed (WordPress could not delete the post, see the status message for details)</li>
<li>460: Post type does not exist</li>
<li>470: Could not create new post; see status message for error details</li>
</ul>
<h4>Actions</h4>
Each operation has its own unique <code>_before</code> and <code>_after</code> actions that can be hooked into. See below for a complete list.
GET
<ul>
<li><code>postsapi_before_get</code></li>
<li><code>postsapi_after_get</code></li>
</ul>
PUT
<ul>
<li><code>postsapi_before_put</code></li>
<li><code>postsapi_after_put</code></li>
</ul>
DELETE
<ul>
<li><code>postsapi_before_delete</code></li>
<li><code>postsapi_after_delete</code></li>
</ul>
POST
<ul>
<li><code>postsapi_before_post</code></li>
<li><code>postsapi_after_post</code></li>
</ul>

Simple Posts API

A Plugin to provide a simple RESTful API to retrieve and manipulate Post data

qnnp

Use the UI interface to test WP-JSON friendly. 
Please make sure your custom route is registered with the namespace!
There is the json content of the entire WP-JSON at the bottom of the plug-in page to prevent you from not being able to find the routing endpoint you need.
There is an original description under each parameter field of the end point.
Except for GET requests, a batch tab will be provided under the request panel.

Restful UI

Use the UI interface to test WP-JSON friendly.

Simple Posts API vs Restful UI