Rest API Osclass Plugin

Developing iOS or Android App and you need effective way to get data out of osclass into your app and backwards? Rest API Plugin for Osclass can handle more than 60 operations!

Rest API for Osclass - Develop your Mobile App

Osclass API can be useful in many different cases, where most important are:

• mobile applications (iOS, Android)
• exporting data to different systems
• synchronization of multiple osclass installations
• reading data into different system
• works great with Ad Importer Plugin for Osclass

Easy to use

Every plugin should be simple to use, and even Rest API is pretty complex and robust solution for sharing and getting osclass information, usage cannot be simpler! Let's just quickly look how easy is to get data using rest api for osclass:

• Get osclass locations
• Get listing data
• Get category listings
• Get category data
• Get latest items
• Get currency list

Sample link to get data:

https://plugins.abprofitrade.eu/oc-content/plugins/rest/api.php?key=test-api-key&type=read&object=region&action=listAll

Osclass Rest API plugin is ideal for that and provides following functionalities:

• handle 60+ different operations on osclass
• create multiple API keys for different usage
• restrict API keys to specific operation (read, insert, update, delete)
• logs history & statistics
• provides output in JSON format

Calls portfolio

Let's look in detail what are calls supported by rest API plugin.

Reading data

Single listing data

• Listing data by item ID
• List of resources of listing
• Location data of listing
• List of meta data (custom fields) of listing
• List of comments of listing
• Count comments on listing

Multiple listings data (list)

• List of items by category
• List of listings by user (contact) email
• List of listings by user ID
• List of enabled listings by user ID

Listing counts

• Count category active/inactive listings
• Count category active/inactive enabled/disabled listings
• Count user ID listings
• Count user ID enabled listings

Category data

• Single category data
• List of subcategories of given category
• List of root categories
• List of categories tree
• List all categories

City data

• Single city data
• Single city data by city name (and region ID)
• List all cities (may be exhaustive)
• Statistics of single city (item count)
• List of cities by region ID

Region data

• Single region data
• Single region data by region name (and country code)
• List of all regions
• Statistics of single region (item count)
• List of regions by country code

Country data

• Single country data
• Single country data by country name
• List of all countries
• Statistics of single country (item count)

Currency data

• Single currency data
• List of all currencies

Locale/language data

• Single locale data
• List of all locales

User data

• Single user data
• Single user data by email
• Count all users
• List of all comments posted by user ID

Search data

• List of available sort columns
• list of available sort options
• List of premium items (randomized)
• List of latest items
• Search items based on provided parameters. All parameters available in bender theme can be passed to URL

Lately searched terms

• List of lately searched terms (storing must be enabled)

Static pages (CMS)

• Single static page data
• List of all static pages

Insert data

Listing & user

• Add an new listing. Same form composition is required as on bender theme - publish form, sending parameters to API url
• Add an new user. Same form composition is required as on bender theme - registration form, sending parameters to API url

Update data

Listing & user

• Mark listing as spam / bad_category / ...
• Activate listing by itemId using item secret code
• Edit listing. Same form composition is required as on bender theme - edit form, sending parameters to API url
• Edit user. Same form composition is required as on bender theme - profile form, sending parameters to API url

Remove data

Listing & user

• Remove listing
• Remove listing resources
• Remove user

Plugins support

Many osclass plugins has been integrated into Rest API, however advanced PHP knowledge and ability to check plugin functions is needed to be effectively work with integration of plugins. Not all functions of plugins are integrated, only core model functions that are really needed has been integrated.

Integration of following plugins is provided:

• Osclass Pay
• Business Profile
• Make Offer
• Attributes
• User Rating
• Youtube Video
• Forums
• Blog
• Virtual products
• Favorite Items
• Instant Messenger
• SMS Notification & Verification (create, update, get verification record)

For details what functions are in API, check backoffice demo of plugin.

Note: This plugin itself only show/expose data for other applications or systems, alternatively it process data received from other applications or systems.