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 Osclass regions 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 140+ different operations with 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 and integration

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.

Rest API Osclass Plugin now covers core classifieds data plus the plugins below, when they are installed on the site.

Core marketplace plugins

• Business Profile - Access company and seller profile pages, pictures, categories, cities, and seller statistics through the API.
• Make Offer - View, create, approve, decline, and pay buyer offers, including per-listing offer settings.
• User Rating - View, add, update, validate, and delete user ratings and rating averages.
• Voting - Let buyers rate listings and other users with stars, and show average scores in the app.
• Youtube Video - View, add, edit, and delete YouTube videos linked to listings.
• Forums - Access forum categories, boards, topics, posts, and users, and let members start topics and reply.
• Blog - Access blog posts, comments, authors, and categories, and let readers post comments.
• Virtual Products - Access downloadable files linked to listings and users, including free downloads and download counts.
• Digital Goods - Attach and list digital files sold with a listing, separate from Virtual Products downloads.
• Attributes - Access attribute definitions and values for categories and listings, and save listing attributes from the app.
• Favorite Items - Manage users favorite listings and lists, including adding, updating, viewing, and removing favorites.
• Saved Items - Let visitors save listings for later, with or without a user account.
• Watchlist - Let logged-in users watch listings and remove them later.
• Instant Messenger - Manage conversations, messages, file attachments, read status, and blocked users.
• Osclass Pay - Access and manage payments, orders, wallets, fees, packs, memberships, shopping carts, shipping, bank transfers, and stock.
• SMS Notification and Verification - Access and manage phone verification records, including code check and lookup by phone.

Payments, booking, and agencies

• Booking - Let customers check dates, get a price, and book a listing, and let sellers manage options and reservations.
• Auction - Let buyers view auctions, place bids, watch auctions, and read auction alerts.
• Agency - Let an agency owner request an agency, invite agents, accept invites, and list members. No login-as-user.
• User Verification - Let a user submit or cancel an identity verification request, including a selfie upload.
• Item Validation - Check listing validation status before the ad goes live.
• Payout - Let sellers save payout details and see upcoming payout amounts.
• Invoice - Let users read invoices and keep their billing profile up to date.
• Voucher - Look up a voucher and its usage stats for a user. Checkout codes stay in Osclass Pay.
• Importer - Run a saved import job and read import logs from the app or an automation tool.
• OpenStreetMaps - Read nearby locations, find the closest city, and save listing coordinates.
• Radius Search - Save listing coordinates and find cities in a radius so search can use distance.

Publish and contact rules

• Item Limit - Check how many listings a user may still publish.
• Image Required - Read the minimum photo count required to publish.
• Contact Limit - Check whether a contact message is allowed before the app sends it.
• Item Password - Check, set, or verify a listing password without returning the secret in API output.
• Item Online Users - Show how many people are viewing a listing now, and ping a view from the app.
• GDPR - Read and update privacy, terms, and newsletter consent flags on users and listings.

Chat, follow, and jobs

• Online Chat - Let users start chats, send messages, mark chats read, close chats, and manage blocks.
• Wall Chat - Access public chat channels and messages, and let users post or block others.
• WhatsApp Chat - Read and update WhatsApp contact widgets on listings, including view and click counts.
• Follow - Let users follow sellers and list followers or following accounts.
• Job Apply - Let candidates submit job applications and let employers read and update them.
• Messenger - Jobs-style inbox and applications between two users, when Messenger is used instead of Job Apply.
• User Custom Fields Pro - Read custom user-profile fields and save the values a member submitted.

Listing fields and compare

• Car Attr Pro - Read car, job, or real-estate field profiles and save listing values from the app.
• Cars Attributes - Read and save car details such as make, model, year, fuel, and mileage.
• Jobs Attributes - Read and save job listing details such as company, salary, and requirements.
• Real Estate Attributes - Read and save property details, including the listing agency field.
• Products Attributes - Read and save product make and model on listings.
• Dating Attributes - Read and save dating preferences on listings.
• Price Comparison - Show related listings and price history for comparison, not a shopping basket.
• Price Tag - Read price tags and set the tag on a listing.

Content, ads, and SEO

• FAQ - Show FAQ categories and articles, track views, and record helpful votes.
• Flash News - Show site news items in the app.
• Testimonials - Show public testimonials.
• Newsletter - Let a user unsubscribe and check unsubscribe status.
• Exchange Rate - Read currency rates and convert prices for the app.
• Banner Ads - Show banners by hook and record views and clicks.
• Advertisement Manager - Show public banner groups and banners, and record views and clicks.
• Age Warning Pro - Read age-gate settings so the app can show a warning on selected categories.
• Story - Let users post listing stories, track views and likes, and remove a story.
• Poll - Show the active poll, accept a vote, and return results.
• SEO Pro - Read SEO titles and descriptions for listings, categories, pages, and locations.
• All in One SEO - Read All in One SEO meta for listings, categories, and pages.
• Sitemap Pro - Trigger sitemap generation from an automation or admin tool.
• AI Assistant - Generate a listing title, description, and category suggestion from a short brief. Provider keys are never returned.
• AI Support Agent - Offer in-app support chat, escalate a session, and send a transcript.
• Share - Read social share stats for a listing and record a share click.
• QR Code - Get the QR image URL for a listing.
• Spam - Check a title or description against banned words. Rest API does not ban users or delete listings.
• Description Cleaner - Sanitize a title or description before the app saves it. Nothing is stored or deleted.
• Cookies Consent Pro - Read public cookie-consent text and policy link for the app.
• Cookie Consent - Read public cookie-consent text and policy link for the app.
• Profile Picture - Get a user profile picture URL.
• Avatar - Get a user avatar URL.

For details what functions are supported by plugin, check API documentation on plugin demo.