Introduction

Installation procedure

Initial configuration

Usage

Keys

Logs

Apps

Devices

Notifications

User Module API

Content Module API

Push Module API

Menu Module API

K2 Module API

SobiPro Module API

ZOO Module API

Kunena Module API

Search Module API

Community Builder Module API

Release System Module API

Error Codes

Developer's guide

Changelog

jBackend is a Joomla extension that gives you all the power of Joomla CMS through an extensible and pluggable set of REST API. With these API you can access to all site's contents and features, and use Joomla as a backend system for smartphone and mobile apps, syndication networks, external websites, and provide web services for any external system.

Furthermore jBackend provides a full push notifications platform for iOS and Android mobile apps. It allows to define multiple apps, to register devices for each app, and to schedule push notifications sending on registered devices, filtered by app and platform type.

Features

• Extensible through plugins to increase API and support any Joomla extension;
• Support for publishing of multiple endpoints, each with its specific settings;
• Three endpoint access type (free access, user authenticated only, API Key required);
• Tracing requests in the database for each endpoint;
• Selection of jBackend plugins to enable for each endpoint;
• API Key management interface;
• Request log management interface;
• Each API Key can have a max daily requests limit and an expiration date;
• Each API Key can be targeted on separate endpoints;
• Access control is compliant with integrated ACL;
• Support for REST compliant requests;
• JSON format for responses;
• Support for push notifications on iOS (APNs) and Android (GCM);
• Custom payload for push notifications;
• Scheduled sending of push notifications;
• Push notifications can be create and scheduled via API call;
• Push notifications can be targeted on selected users or groups.

The basic extension package includes the jBackend component, that provides the general infrastructure for endpoints, notifications, and plugins support system. Also the following plugins are already included in the basic package:

• User Module: provides support for Joomla users (e.g. login, logout, registration);
• Content Module: provides support for standard Joomla content (e.g. categories and articles);
• Push Module: provides support for push notifications (e.g. register device, send scheduled push);

Additional plugins can be downloaded from here and installed separately. Before to buy a subscription check here if what you need is already available, or submit a support request.

It is also possible to give it a try downloading and installing jBackend Community for free, a lite version created to give a chance to test jBackend capabilities, to develop and test new modules, and to provide some basic REST API integration features to a Joomla site.

jBackend is released under GPL 2.0 license.