Description
IdeaPress convert your wordpress (both wordpress.com and self hosted site) into Android, iOS, winphone and windows app! It is used to compliment Ideapress multi-screen application.
About IdeaPress
IdeaPress aims to make the mobile app space more accessible to everyone by providing an avenue for coders and non-coders to develop beautiful apps.
IdeaPress has been endorsed by Microsoft CANADA and it is used by magazines and wordpress shop around the world. It has been showcase in WordCamp 2013 DemoCamp, StartUpTO, DevTO. If you want to turn your wordpress site into iOS, Android and WinPhone, it might be the tool for you.
Build your own mobile app
IdeaPress is an online that convert your site into moible app in 3 steps. WordPress is best known for its ease-of-use and customization options. When you’re making your iOS, Android and Winphone apps with IdeaPress, you get to choose exactly how you want to make your app ranging from the content that’s included to the design and styling. In addition, we will help you publish to app store.
Features
IdeaPress comes with loads of features out of the box
-
Offline Browsing
Tired of not being able to read your content you have no internet? Solve the problem with IdeaPress! IdeaPress stores the content of your website so that it can be accessed on mobile devices anytime, anywhere!
-
Posts and Pages
Choose which categories and pages you want to include in your apps and even choose different content for platforms, whether it be iOS, Android or Windows Phone. IdeaPress format your content to fit on all devices, so your posts and pages look good on the go!
-
Bookmarking, Sharing and Searching
One of the main reasons to get an app over a mobile website is to take advantage of device native features. IdeaPress apps can harness the power of the devices that they are on across all platforms and let users search the content of your website, share posts and pages and bookmark articles for later viewing.
-
Dynamic updating
While most apps have to be resubmitted to the store when updating, IdeaPress apps can be updated through your dashboard and have the changes pushed directly to the apps withing minutes without re-publishing. Users get to benefit from your changes almost instantly instead of waiting for store certification.
This plugin is developed by Idea Notion
This plugin is developed base on JSON-API, it will add additional functionality to the original JSON API, slim down the return objects and add additional functionality for Ideapress applications
Documentation
This plugin base on WordPress JSON-API plugin and we modified the plugin to taylor the need of Ideapress multi-screen application. Most of the methods are supported, an additional get_recent_posts_on_hub is being added for smaller return size and Posts Control is dropped. The rest of this section is base on JSON-API documentation.
- General concepts
1.1. Requests
1.2. Controllers
1.3. Responses - Request methods
2.1. Core controller methods
2.2. Respond controller methods - Request arguments
3.1. Output-modifying arguments
3.2. Content-modifying arguments
3.3. Using include/exclude and redirects - Response objects
4.1. Post response object
4.2. Category response object
4.3. Tag response object
4.4. Author response object
4.4. Comment response object
4.5. Attachment response object
1. General Concepts
1.1. Requests
Requests use a simple REST-style HTTP GET or POST. To invoke the API, include a non-empty query value for json in the URL.
JSON API operates in two modes:
- Implicit mode is triggered by setting the
jsonquery var to a non-empty value on any WordPress page. The content that would normally appear on that page is returned in JSON format. - Explicit mode is triggered by setting
jsonto a known method string. See Section 2: Request methods for a complete method listing.
Implicit mode examples:
https://www.example.org/?json=1https://www.example.org/?p=47&json=1https://www.example.org/tag/banana/?json=1
Explicit mode examples:
https://www.example.org/?json=get_recent_postshttps://www.example.org/?json=get_post&post_id=47https://www.example.org/?json=get_tag_posts&tag_slug=banana
With user-friendly permalinks configured:
https://www.example.org/api/get_recent_posts/https://www.example.org/api/get_post/?post_id=47https://www.example.org/api/get_tag_posts/?tag_slug=banana
Further reading
See Section 3: Request arguments for more information about request arguments to modify the response.
1.2. Controllers
The 1.0 release of JSON API introduced a modular controller system. This allows developers to flexibly add features to the API and give users more control over which methods they have enabled.
The Core controller
Most of the methods available prior to version 1.0 have been moved to the Core controller. The two exceptions are submit_comment and create_post which are now available from the Respond and Posts controllers, respectively. The Core controller is the only one enabled by default. All other functionality must be enabled from the JSON API Settings page (under Settings in the WordPress admin menu).
Specifying a controller
There are a few ways of specifying a controller, depending on how you are calling the API:
https://www.example.org/?json=get_recent_posts(corecontroller is implied, method isget_recent_posts)https://www.example.org/api/info/(corecontroller is implied)https://www.example.org/api/core/get_category_posts/(corecontroller can also be explicitly specified)https://www.example.org/?json=respond.submit_comment(respondcontroller,submit_commentmethod)
Legacy compatibility
JSON API retains support for its pre-1.0 methods. For example, if you invoke the method create_post without a controller specified, the Posts controller is chosen instead of Core.
Available controllers
The current release includes three controllers: Core, Posts, and Respond. Developers are encouraged to suggest or submit additional controllers.
Further reading
See Section 2: Request methods for a complete reference of available controllers and methods. For documentation on extending JSON API with new controllers see Section 5.2: Developing JSON API controllers.
1.3. Responses
The standard response format for JSON API is (as you may have guessed) JSON.
Here is an example response from https://localhost/wordpress/?json=1 called on a default WordPress installation (formatted for readability):
{
"status": "ok",
"count": 1,
"count_total": 1,
"pages": 1,
"posts": [
{
"id": 1,
"type": "post",
"slug": "hello-world",
"url": "http:\/\/localhost\/wordpress\/?p=1",
"title": "Hello world!",
"title_plain": "Hello world!",
"content": "<p>Welcome to WordPress. This is your first post. Edit or delete it, then start blogging!<\/p>\n",
"excerpt": "Welcome to WordPress. This is your first post. Edit or delete it, then start blogging!\n",
"date": "2009-11-11 12:50:19",
"modified": "2009-11-11 12:50:19",
"categories": [],
"tags": [],
"author": {
"id": 1,
"slug": "admin",
"name": "admin",
"first_name": "",
"last_name": "",
"nickname": "",
"url": "",
"description": ""
},
"comments": [
{
"id": 1,
"name": "Mr WordPress",
"url": "http:\/\/www.ads-software.com\/",
"date": "2009-11-11 12:50:19",
"content": "<p>Hi, this is a comment.<br \/>To delete a comment, just log in and view the post's comments. There you will have the option to edit or delete them.<\/p>\n",
"parent": 0
}
],
"comment_count": 1,
"comment_status": "open"
}
]
}<h3>2. Request methods</h3>
Request methods are available from the following controllers:
- Core controller – basic introspection methods
- Posts controller – data manipulation methods for posts
- Respond controller – comment/trackback submission methods
2.1. Core controller methods
The Core controller offers a mostly-complete set of introspection methods for retrieving content from WordPress.
Method: info
Returns information about JSON API.
Optional arguments
controller– returns detailed information about a specific controller
Response
{
"status": "ok",
"json_api_version": "1.0",
"controllers": [
"core"
]
}
Response
{
"status": "ok",
"name": "Core",
"description": "Basic introspection methods",
"methods": [
...
]
}<h3>Method: get_recent_posts</h3>
Returns an array of recent posts. You can invoke this from the WordPress home page either by setting json to a non-empty value (i.e., json=1) or from any page by setting json=get_recent_posts.
Optional arguments
count– determines how many posts per page are returned (default value is 10)page– return a specific page number from the resultspost_type– used to retrieve custom post types
Response
{
"status": "ok",
"count": 10,
"count_total": 79,
"pages": 7,
"posts": [
{ ... },
{ ... },
...
]
}<h3>Method: get_recent_posts_on_hub</h3>
Returns an array of recent posts. You can invoke this from any page by setting json=get_recent_posts_on_hub. This function slims down the content because on hub page, multi-screen app doesn’t need the full content and it remove the return comments to decrease the size of return item.
Optional arguments
count– determines how many posts per page are returned (default value is 10)page– return a specific page number from the resultspost_type– used to retrieve custom post types
Response
{
"status": "ok",
"count": 10,
"count_total": 79,
"pages": 7,
"posts": [
{ ... },
{ ... },
...
]
}<h3>Method: ideapress_server_ping</h3>Returns true. Make sure the the server has installed the plugin
Response
{
"status": "ok",
"result": true
}<h3>Method: get_post</h3>
Returns a single post object.
One of the following is required
- Invoking the JSON API implicitly (i.e.,
?json=1) on a post URL idorpost_id– set to the post’s IDslugorpost_slug– set to the post’s URL slug
Optional arguments
post_type– used to retrieve custom post types
Response
{
"status": "ok",
"post": { ... }
}<h3>Method: get_page</h3>
Returns a single page object.
One of the following is required
- Invoking the JSON API implicitly (i.e.,
?json=1) on a page URL idorpage_id– set to the page’s IDslugorpage_slug– set to the page’s URL slug
Optional arguments
children– set to a non-empty value to include a recursive hierarchy of child pagespost_type– used to retrieve custom post types
Response
{
"status": "ok",
"page": { ... }
}<h3>Method: get_date_posts</h3>
Returns an array of posts/pages in a specific date archive (by day, month, or year).
One of the following is required
- Invoking the JSON API implicitly (i.e.,
?json=1) on a date archive page date– set to a date in the formatYYYYorYYYY-MMorYYYY-MM-DD(non-numeric characters are stripped from the var, soYYYYMMDDorYYYY/MM/DDare also valid)
Optional arguments
count– determines how many posts per page are returned (default value is 10)page– return a specific page number from the resultspost_type– used to retrieve custom post types
Response
{
"status": "ok",
"count": 10,
"count_total": 79,
"pages": 7,
"posts": [
{ ... },
{ ... },
...
]
}<h3>Method: get_category_posts</h3>
Returns an array of posts/pages in a specific category.
One of the following is required
- Invoking the JSON API implicitly (i.e.,
?json=1) on a category archive page idorcategory_id– set to the category’s IDslugorcategory_slug– set to the category’s URL slug
Optional arguments
count– determines how many posts per page are returned (default value is 10)page– return a specific page number from the resultspost_type– used to retrieve custom post types
Response
{
"status": "ok",
"count": 10,
"count_total": 79,
"pages": 7,
"category": { ... }
"posts": [
{ ... },
{ ... },
...
]
}<h3>Method: get_tag_posts</h3>
Returns an array of posts/pages with a specific tag.
One of the following is required
- Invoking the JSON API implicitly (i.e.,
?json=1) on a tag archive page idortag_id– set to the tag’s IDslugortag_slug– set to the tag’s URL slug
Optional arguments
count– determines how many posts per page are returned (default value is 10)page– return a specific page number from the resultspost_type– used to retrieve custom post types
Response
{
"status": "ok",
"count": 10,
"count_total": 79,
"pages": 7,
"tag": { ... }
"posts": [
{ ... },
{ ... },
...
]
}<h3>Method: get_author_posts</h3>
Returns an array of posts/pages written by a specific author.
One of the following is required
- Invoking the JSON API implicitly (i.e.,
?json=1) on an author archive page idorauthor_id– set to the author’s IDslugorauthor_slug– set to the author’s URL slug
Optional arguments
count– determines how many posts per page are returned (default value is 10)page– return a specific page number from the resultspost_type– used to retrieve custom post types
Response
{
"status": "ok",
"count": 10,
"count_total": 79,
"pages": 7,
"author": { ... }
"posts": [
{ ... },
{ ... },
...
]
}<h3>Method: get_search_results</h3>
Returns an array of posts/pages in response to a search query.
One of the following is required
- Invoking the JSON API implicitly (i.e.,
?json=1) on a search results page search– set to the desired search query
Optional arguments
count– determines how many posts per page are returned (default value is 10)page– return a specific page number from the resultspost_type– used to retrieve custom post types
Response
{
"status": "ok",
"count": 10,
"count_total": 79,
"pages": 7,
"posts": [
{ ... },
{ ... },
...
]
}<h3>Method: get_date_index</h3>
Returns both an array of date page permalinks and a tree structure representation of the archive.
Response
{
"status": "ok",
"permalinks": [
"...",
"...",
"..."
],
"tree": {
"2009": {
"09": 17,
"10": 20,
"11": 7
}
}
Note: the tree is arranged by response.tree.[year].[month].[number of posts].
Method: get_category_index
Returns an array of active categories.
Response
{
"status": "ok",
"count": 3,
"categories": [
{ ... },
{ ... },
{ ... }
]
}<h3>Method: get_tag_index</h3>
Returns an array of active tags.
Response
{
"status": "ok",
"count": 3
"tags": [
{ ... },
{ ... },
{ ... }
]
}<h3>Method: get_author_index</h3>
Returns an array of active blog authors.
Response
{
"status": "ok",
"count": 3,
"authors": [
{ ... },
{ ... },
{ ... }
]
}<h3>Method: get_page_index</h3>
Returns a hierarchical tree of page posts.
Response
{
"status": "ok",
"pages": [
{ ... },
{ ... },
{ ... }
]
}<h3>Method: get_nonce</h3>
Returns a WordPress nonce value, required to call some data manipulation methods.
Required arguments
controller– the JSON API controller for the method you will use the nonce formethod– the method you wish to call (currentlycreate_postis the only method that requires a nonce)
Response
{
"status": "ok",
"controller": "posts",
"method": "create_post",
"nonce": "cefe01efd4"
}
Further reading
To learn more about how nonces are used in WordPress, see Mark Jaquith’s article on the subject.
2.2. Pages controller methods
Method: create_post
Creates a new post.
Required argument
nonce– available from theget_noncemethod (call with varscontroller=postsandmethod=create_post)
Optional arguments
status– sets the post status (“draft” or “publish”), default is “draft”title– the post titlecontent– the post contentauthor– the post’s author (login name), default is the current logged in usercategories– a comma-separated list of categories (URL slugs)tags– a comma-separated list of tags (URL slugs)
Note: including a file upload field called attachment will cause an attachment to be stored with your new post.
2.3. Respond controller methods
Method: submit_comment
Submits a comment to a WordPress post.
Required arguments
post_id– which post to comment onname– the commenter’s nameemail– the commenter’s email addresscontent– the comment content
Optional arguments
redirect– redirect instead of returning a JSON objectredirect_ok– redirect to a specific URL when the status value isokredirect_error– redirect to a specific URL when the status value iserrorredirect_pending– redirect to a specific URL when the status value ispending
Custom status values
pending– assigned if the comment submission is pending moderation
3. Request arguments
API requests can be controlled by specifying one of the following arguments as URL query vars.
Examples
- Debug the response:
https://www.example.org/api/get_page_index/?dev=1 - Widget-style JSONP output:
https://www.example.org/api/get_recent_posts/?callback=show_posts_widget&read_more=More&count=3 - Redirect on error:
https://www.example.org/api/posts/create_post/?callback_error=http%3A%2F%2Fwww.example.org%2Fhelp.html
3.1. Output-modifying arguments
The following arguments modify how you get results back from the API. The redirect response styles are intended for use with the data manipulation methods.
- Setting
callbackto a JavaScript function name will trigger a JSONP-style callback. - Setting
redirectto a URL will cause the user’s browser to redirect to the specified URL with astatusvalue appended to the query vars (see the Response objects section below for an explanation of status values). - Setting
redirect_[status]allows you to control the resulting browser redirection depending on thestatusvalue. - Setting
devto a non-empty value adds whitespace for readability and responds withtext/plain - Omitting all of the above arguments will result in a standard JSON response.
3.2. Content-modifying arguments
These arguments are available to modify all introspection methods:
date_format– Changes the format of date values. Uses the same syntax as PHP’s date() function. Default value isY-m-d H:i:s.read_more– Changes the ‘read more’ link text in post content.include– Specifies which post data fields to include. Expects a comma-separated list of post fields. Leaving this empty includes all fields.exclude– Specifies which post data fields to exclude. Expects a comma-separated list of post fields.custom_fields– Includes values from posts’ Custom Fields. Expects a comma-separated list of custom field keys.author_meta– Includes additional author metadata. Should be a comma-separated list of metadata fields.count– Controls the number of posts to include (defaults to the number specified by WordPress)order– Controls the order of post results (‘DESC’ or ‘ASC’). Default value is ‘DESC’.order_by– Controls which field to order results by. Expects one of the following values:authordate(default value)titlemodifiedmenu_order(only works with Pages)parentIDrandmeta_value(meta_keymust also be set)nonecomment_count
meta_key,meta_value,meta_compare– Retrieve posts (or Pages) based on a custom field key or value.
3.3. Using include/exclude and redirects
About include/exclude arguments
By default you get all values included with each post object. Specify a list of include values will cause the post object to filter out the values absent from the list. Specifying exclude causes post objects to include all values except the fields you list. For example, the query exclude=comments includes everything except the comments.
About the redirect argument
The redirect response style is useful for when you need the user’s browser to make a request directly rather than making proxy requests using a tool like cURL. Setting a redirect argument causes the user’s browser to redirect back to the specified URL instead of returning a JSON object. The resulting status value is included as an extra query variable.
For example calling an API method with redirect set to https://www.example.com/foo will result in a redirection to one of the following:
https://www.example.com/foo?status=okhttps://www.example.com/foo?status=error
You can also set separate URLs to handle status values differently. You could set redirect_ok to https://www.example.com/handle_ok and redirect_error to https://www.example.com/handle_error in order to have more fine-tuned control over the method result.
4. Response objects
This section describes data objects you can retrieve from WordPress and the optional URL redirects.
Status values
All JSON API requests result in a status value. The two basic status values are ok and error. Additional status values are available for certain methods (such as pending in the case of the submit_comment method). API methods that result in custom status values include a custom status values section in their documentation.
Naming compatibility
Developers familiar with WordPress may notice that many names for properties and arguments have been changed. This was a stylistic choice that intends to provide more clarity and consistency in the interface.
4.1. Post response object
id– Integertype– String (e.g.,postorpage)slug– Stringurl– Stringtitle– Stringtitle_plain– Stringcontent– String (modified by theread_moreargument)excerpt– Stringdate– String (modified by thedate_formatargument)modified– String (modified by thedate_formatargument)categories– Array of category objectstags– Array of tag objectsauthorAuthor objectcomments– Array of comment objectsattachments– Array of attachment objectscomment_count– Integercomment_status– String ("open"or"closed")thumbnail– String (only included if a post thumbnail has been specified)custom_fields– Object (included by setting thecustom_fieldsargument to a comma-separated list of custom field names)
Note
The thumbnail attribute returns a URL to the image size specified by the optional thumbnail_size request argument. By default this will use the thumbnail or post-thumbnail sizes, depending on your version of WordPress. See Mark Jaquith’s post on the topic for more information.
4.2. Category response object
id– Integerslug– Stringtitle– Stringdescription– Stringparent– Integerpost_count– Integer
4.3. Tag response object
id– Integerslug– Stringtitle– Stringdescription– Stringpost_count– Integer
4.4. Author response object
id– Integerslug– Stringname– Stringfirst_name– Stringlast_name– Stringnickname– Stringurl– Stringdescription– String
Note: You can include additional values by setting the author_meta argument to a comma-separated list of metadata fields.
4.5. Comment response object
id– Integername– Stringurl– Stringdate– Stringcontent– Stringparent– Integerauthor– Object (only set if the comment author was registered & logged in)
4.6. Attachment response object
id– Integerurl– Stringslug– Stringtitle– Stringdescription– Stringcaption– Stringparent– Integermime_type– Stringimages– Object with values includingthumbnail,medium,large,full, each of which are objects with valuesurl,widthandheight(only set if the attachment is an image)
Screenshots
Installation
- Upload the
ideapress-json-apifolder to the/wp-content/plugins/directory or install directly through the plugin installer. - Activate the plugin through the ‘Plugins’ menu in WordPress or by using the link provided by the plugin installer.
FAQ
- Why the plugin doesn’t work?
It cannot work together with other json api plugin
Reviews
Contributors & Developers
“IdeaPress – Turn WordPress into Mobile Apps (Android, iPhone, WinPhone)” is open source software. The following people have contributed to this plugin.
Contributors
Interested in development?
Browse the code, check out the SVN repository, or subscribe to the development log by RSS.
Changelog
Initial checkin