BraDyCMS

BraDypUS CMS

View the Project on GitHub jbogdani/BraDyCMS

BraDyCMS API documentantion

This functionality is still under development and may change in the future. Please read carefully the following doc, that will be carefully updated to reflect in real time all changes.

BraDyCMS integrates, from v. 3.4, an RESTful API which allows users to easily retrieve data from articles, menus, etc. in JSON format, to be reused in many different ways (eg., to build an mobile app).

Up to present (v. 3.6) the API can be used only for retrieving data (read-only), but soon it will be possible to use this interface also for editing and erasing data.

Base URL

The API can be reached by adding /api/ to your base URL, eg. the API for the domain http://bradypus.net can be accessed at http://bradypus.net/api/.

Parameters

Parameter Type Required/optional Description
action strin required Action API should handle. Actually only read
menu mixed optional The menu name or array of menu names to return
tag mixed optional The tag or array of tags to use as filter for getting articles.
metadata boolean optional If true all site metadata will be returned.
artid mixed optional Article textid or array of articles textid used as filter for getting articles.

Examples