JSON Content Importer

Description

Display live data from a JSON-feed / API on your wordpress-site!

This is the answer when you ask: Why Do I Need this Plugin on my Website?

JSON Content Importer – API- and Webservice-Connector – Powerful and Simple JSON-Import Plugin:

  • Use a template engine to display the data of an JSON-Feed.
  • Define the url of the JSON-Feed, a template for it and other options like number of displayed items, cachetime etc..
  • The template engine inserts the JSON-data in the template provided in the wordpress-shortcode inside a page – whereby some extras like urlencoding can be invoked.

How to start and help

Simple Example of wordpress-shortcode

‘[jsoncontentimporter

  • url=”http://…json”
  • numberofdisplayeditems=”number: how many items of level 1 should be displayed? display all: leave empty or set -1″
  • urlgettimeout=”number: who many seconds for loading url till timeout?”
  • basenode=”starting point of datasets, the base-node in the JSON-Feed where the data is”
  • oneofthesewordsmustbein=”default empty, if not empty keywords spearated by ‘,’. At least one of these keywords must be in the created text (here: text=code without html-tags)”
  • oneofthesewordsmustbeindepth=”default: 1, number: where in the JSON-tree oneofthesewordsmustbein must be?”

]

Any HTML-Code plus “basenode”-datafields wrapped in “{}”
{subloop:”basenode_subloop”:”number of subloop-datasets to be displayed”}
Any HTML-Code plus “basenode_subloop”-datafields wrapped in “{}”. If JSON-data is HTML add “html” flag like “{fieldname:html}”
{/subloop:”basenode_subloop”}

[/jsoncontentimporter]’

  • templates like “{subloop-array:AAAA:10}{text}{subloop:AAAA.image:10}{id}{/subloop:AAAA.image}{/subloop-array:AAAA}” are possible:
    one is the recursive usage of “subloop-array” and “subloop”.
    the other is “{subloop:AAAA.image:10}” where “AAAA.image” is the path to an object. This is fine for some JSON-data.

Some special add-ons for datafields

  • “{street:purejsondata}”: Default-display of a datafield is NOT HTML, but HTML-Tags are converted : use this to use really the pure data from the JSON-Feed
  • “{street:html}”: Default-display of a datafield is NOT HTML: “<” etc. are converted to “&amp,lt;”. Add “html” to display the HTML-Code as Code.
  • “{street:htmlAndLinefeed2htmlLinefeed}”: Same as “{street:html}” plus “\n”-Linefeeds are converted to HTML-Linebreak
  • “{street:ifNotEmptyAddRight:,}”: If datafield “street” is not empty, add “,” right of datafield-value. allowed chars are: “a-zA-Z0-9,;_-:<>/ “
  • “{street:html,ifNotEmptyAddRight:extratext}”: you can combine “html” and “ifNotEmptyAdd…” like this
  • “{street:ifNotEmptyAdd:,}”: same as “ifNotEmptyAddRight”
  • “{street:ifNotEmptyAddLeft:,}”: If datafield “street” is not empty, add “,” left of datafield-value. allowed chars are: “a-zA-Z0-9,;_-:<>/ “
  • “{locationname:urlencode}”: Insert the php-urlencoded value of the datafield “locationname”. Needed when building URLs

JSON Content Importer PRO

This free version of “JSON Content Importer” can put together many JSON-Feeds and is flexible with it’s template-engine. But sometimes you might need more:

  • using as Widget
  • create custom post types
  • application building by creating a searchform and connect it to a JSON-API in the background: pass GET-Variables to use a dynamic JSON-Feed-URL (“talk to API / webservice”)
  • usage on multisite installations
  • store Templates independent of pages
  • more Shortcode-Parameters
  • executing Shortcodes inside a template and
  • more features…

If the free version comes to your limit, I’m looking forward that you COMPARE PRO and FREE of the JSON Content Importer.

Screenshots

  • This screen shows the description and settings-page of the "JSON Content Importer"-Plugin
  • This screen shows the WordPress-Editor with some [jsoncontentimporter]-code

Installation


For detailed installation instructions, please read the standard installation procedure for WordPress plugins.

  1. Login to your WordPress installation
  2. Install plugin by uploading json-content-importer.zip to /wp-content/plugins/.
  3. Activate the plugin through the Plugins menu.
  4. Klick on “JSON Content Importer” menuentry in the left bar: basic caching-settings and more instructions about usage.
  5. Cache folder: WP_CONTENT_DIR.’/cache/jsoncontentimporter’. So “WP_CONTENT_DIR.’/cache/'” must be writable for the http-daemon. The plugin checks this and might aborts with an error-message like dir is missing or not writeable. if so: check permissions of the directories.

FAQ

Installation Instructions


For detailed installation instructions, please read the standard installation procedure for WordPress plugins.

  1. Login to your WordPress installation
  2. Install plugin by uploading json-content-importer.zip to /wp-content/plugins/.
  3. Activate the plugin through the Plugins menu.
  4. Klick on “JSON Content Importer” menuentry in the left bar: basic caching-settings and more instructions about usage.
  5. Cache folder: WP_CONTENT_DIR.’/cache/jsoncontentimporter’. So “WP_CONTENT_DIR.’/cache/'” must be writable for the http-daemon. The plugin checks this and might aborts with an error-message like dir is missing or not writeable. if so: check permissions of the directories.
Help! I need more information!

Check the plugin-website!

What does this plugin do?

This plugin gives a wp-shortcode for use in a page/blog to import, cache and display JSON-data. Inside wp-shortcode some markups (and attributes like urlencode) are defined to define how to display the data.

How can I make sure the plugin works?

Create a sample-page and use the wordpress-shortcode “jsoncontentimporter”. An example is given in the plugin-configpage and in the “Description”-Section.
there are 2 steps: . access to JSON and convert it to HTML: Step 1: Get access to the JSON-data and Step 2: Convert JSON to HTML.
The Pro-version comes with a installation-check option.

Who do I find the proper template for my JSON?

Check the plugin-website!
Free-Version: If you’re lost: open ticket at wordPress.org please provide the JSON-code or link to it (either in the posting or in a mail to the plugin author).

Don’t forget:

Donate whatever this plugin is worth for you

What does this plugin NOT do?

The plugins templateengine of the free version is focused on some basic JSON-imports.
If this comes to a limit check out the pro-version: There you can use the twig-templatengine, create custom posts out of JSON and many other features.
Your options if this plugin does not work:

Where is this plugin from?

This plugin is made in munich, bavaria, germany!
Famous for Oktoberfest, FC Bayern Munich, AllianzArena, DLD, TUM, BMW, Siemens, seas, mountains and much more…

Reviews

Excellent plugin and support!

I had a problem showing my feed. Contacted the developer and got the correct code to use. No runaround. straight code to try. So refreshing after past problems with other plugin developers. Works like a charm now. Many Thanks!

This plugin is a lifesaver!

This plugin is so incredibly useful and truly extends the functionality of WordPress, especially for folks like me who don’t write custom PHP. It allows you to display content from virtually any application that provides API data in JSON format. Systems can be integrated in a way that isn’t really possible otherwise. Thanks for a great plugin!

Read all 23 reviews

Contributors & Developers

“JSON Content Importer” is open source software. The following people have contributed to this plugin.

Contributors

Changelog

1.2.19

  • Plugin is ok with WordPress 4.9.1
  • Adding “debugmode=10” to the Shortcode parameters will show you info about the API-JSON-retrieve and the used template for converting to HTML.
  • Ever since the plugin uses the PHP function “mb_check_encoding” to detect a maybe needed character-conversion. Unfortunately some WordPress/PHP-installations do not have the PHP-optional “Multibyte String”-library required for that. Then the plugin does not work. Now the availablility of “mb_check_encoding” is checked: If it’S not there the conversion-feature is disabled.
  • At the Plugin-options you can set a “Bearer”-accesskey for oAuth-Bearer-Authentication. The there defined accesskey-string is sent to the API as “Authorization:Bearer accesskey”. Some APIs just need “Authorization:accesskey”. So “Bearer ” should not sent. To do this add “nobearer ” (with one space at the end) at the beginning of the option-field.

1.2.18

  • Plugin is ok with WordPress 4.7.5
  • New option: Add Default Useragent for http-request (some APIs need that)

1.2.17

  • Plugin is ok with WordPress 4.7
  • https instead of http for Plugin-Website
  • Remove invalid quotation marks in shortcode-attributes (when copypasting example code this can happen)

1.2.16

  • Plugin is ok with WordPress 4.6.1
  • Plugin is ok with PHP 7.0
  • Cleaner Code

1.2.15

  • Plugin is ok with WordPress 4.5.2
  • Added features for coming future addons

1.2.14

  • Plugin is ok with WordPress 4.5
  • Improved description

1.2.13

  • Caching-Bug Fixed: WordPress 4.4.2 does not create a “/cache/” folder. If “/cache/” is missing, the plugin creates on. This is relevant for totally new WordPress installations, as older ones should have such a directory.

1.2.12

  • Plugin is ok with WordPress 4.4
  • minor change: prevent direct calls of plugin
  • bug fixed: path of cached files is now set ok

1.2.11

  • bugfix: problems with numeric JSON-values and field manipulators like {JSONkey:ifNotEmptyAdd:….}
  • beta feature Vers. 0.2: Fixed bug in using oAuth-Bearer-Accesscode for authentification at JSON-Server: Bearer-Code is added to the Request-Header.

1.2.10

  • bugfix: caching now works even with very long URLs
  • beta feature: On the Optionpage you can set an oAuth-Bearer-Accesscode for authentification at JSON-Server: This Bearer-Code is added to the Request-Header.

1.2.9

  • new: “{street:purejsondata}”: Default-display of a datafield is NOT HTML, but HTML-Tags are converted. If you want to use really the pure data from the JSON-Feed, add “:purejsondata”. Try first {street}, then {street:html} and then {street:purejsondata}. In some cases: Take care that “meta http-equiv=content-type…” is set to “utf-8”

1.2.8

  • bugfix: handling of JSON-values with $

1.2.7

  • WordPress 4.3.1: check – all ok
  • bugfix: correct encoding of spaces when using {FIELD:html}
  • bugfix: deleting unfilled template-items containing dots

1.2.6

  • WordPress 4.3: check – all ok
  • added feature: remove unfilled template-placeholders {…}
  • introducing “JSON Content Importer PRO”

1.2.5

  • WordPress 4.2.3: check
  • minor bugfix regarding attribute “ifNotEmptyAddRight”
  • new Pluginwebsite: http://json-content-importer.com/

1.2.4

  • “&” in JSON-Feed-URLs are replaced by “&”

1.2.3

  • added a donated feature: new shortcode-params “oneofthesewordsmustnotbein”, “oneofthesewordsmustnotbeindepth”. This is for excluding JSON-data from display: When one of the “,”-separated keywords at “oneofthesewordsmustnotbein” is found in the textblock, ignore this textblock

1.2.2

  • minor bugfix: JSON-Structures like { “$a”: “$b”} can be handled (before: “$” made problems)

1.2.1

  • new feature “{street:htmlAndLinefeed2htmlLinefeed}”: Text-Linefeeds of JSON-data are converted to HTML-Linefeeds
  • Boolean JSON-Values were ignored before this version. Now the text “true” or “False” is displayed
  • Bugfixing Cacher: Timeout-Parameter of cache was not handled right
  • Fixed a bug with JSON-Value containing “$”

1.2.0

  • new shortcode-parameter: “oneofthesewordsmustbein” and “oneofthesewordsmustbeindepth”
  • filter & hook for third party extensions added: hook “json_content_importer_extension” and filter “json_content_importer_result_root”
  • Sourcecode: Classes rearranged
  • minor bugfix: number of items in subloop/subloop-array was sometimes ignored and all was displayed
  • “made in munich” added (see faq)

1.1.2

  • Bugfix: tags like “{aa/aa}” are ok (previous: error)
  • Display JSON-HTML-Data really as HTML. Default: JSON-HTML-Data is displayed not as HTML but as HTML-Text. New in this version: tag-sytax like “{tag:html}” or “{street:html,ifNotEmptyAddRight:extratext}” allows real HTML-display.
  • New parameter in “[jsoncontentimporter]”-shortcode: set http-timeout “urlgettimeout”. default is 5 seconds (ueful if source-website of JSON is slow)
  • Logo of plugin: WordPress-Logo inserted
  • Update of screenshots

1.1.1

Bugfixes

1.1.0

Completely rewritten template engine for even better JSON-handling:

  • “subloop-array”: key should also be in the closing tag, e.g. “{subloop-array:KEY:10}{some_array_field}{/subloop-array:KEY}”.
    The “subloop-array” without KEY in the closing tag is ok if there is only one “subloop-array” in the template. But if there are more than one “subloop-array” in the template insert the KEY in the closing tag!
    Then the template engine can identify the correct JSON-data.

  • “subloop”: what is above for “subloop-array” is also for “subloop”, e.g. “{subloop:KEY:10}{some_object_field}{/subloop:KEY}”

  • templates like “{subloop-array:AAAA:10}{text}{subloop:AAAA.image:10}{id}{/subloop:AAAA.image}{/subloop-array:AAAA}” are possible:
    one is the recursive usage of “subloop-array” and “subloop”.
    the other is “{subloop:AAAA.image:10}” where “AAAA.image” is the path to an object.

  • JSON-data with multiple use of arrays can be handled by the template engine

1.0.5

  • Added Screenshots
  • Enhanced “subloop-array”, new processing of pure string/numeric-array data (before: only string/numeric-data in an object)
  • Enhanced FAQs: Added Link to Website for better creating shortcode-markups

1.0.4

Bugfixes

1.0.3

Enhanced the template engine for better JSON-handling.

1.0.2

Initial release on WordPress.org. Any comments and feature-requests are welcome: blog@kux.de