Docs
< All Articles
Print

Bridge Web API

Posted
Updated

1. Introduction

This add-on works with the Real Estate Manager Pro WordPress Plugin, which is designed to integrate your WordPress website with the RETS Bridge API, allowing you to display detailed property listings on your site directly. The plugin fetches property data directly from the API and presents it in an organized and user-friendly manner, with features like image galleries, maps, and property details.

2. Plugin Installation

2.1. Prerequisites

  • A WordPress website with Real Estate Manager v12.4+ installed.
  • Access to the Bridge Web API, including access_token and dataset_id.

2.2. Installation Steps

  1. Download the Plugin: Obtain the plugin ZIP file from the client area.
  2. Upload the Plugin:
    • Go to your WordPress admin dashboard.
    • Navigate to Plugins > Add New > Upload Plugin.
    • Click Choose File, select the plugin ZIP file, and click Install Now.
  3. Activate the Plugin:
    • After installation, click on Activate Plugin.
  4. Plugin Settings:
    • Navigate to the plugin settings page under Settings > Real Estate Manager -> Bridge API.
    • Enter your API credentials (access_token and dataset_id).
    • You can provide comma-separated counties as well for the county-specific listings.
    • Provide the total number of listings to display at a time, after that pagination will appear.
    • Choose a page to display single property contents. Make sure this page has the shortcode [rem_bridgeoutput_single_property]
    • Save the changes.

3. How to Use the Plugin

3.1. Display Property Listings

To display a list of properties on a page or post:

  1. Create a New Page or Post:
    • Go to Pages > Add New or Posts > Add New.
  2. Add the Shortcode:
    • Use the [rem_bridgeoutput_properties] shortcode to display the property listings.
  3. Publish the page or post.

3.2. Property Fields and Sections (Single Property Page)

To display property fields and sections on the single property page, you can create them from the Fields Builder. Make sure the data name matches the field name in your dataset ID.

This way it will auto-fetch that data and display it on the single property page like this.

 

3.3. Configure Image Gallery

The plugin supports different types of image galleries all the settings come from the main plugin settings

  1. Access Gallery Settings:
    • Navigate to Real Estate Listings > Settings > Single Property Page.
  2. Choose Gallery Type:
    • Select from options like Fotorama, Slick, or Grid.
    • Save your settings.

3.4. Map Integration

The plugin can display property locations using Google Maps or Leaflet.

  1. Choose Map Provider:
    • Go to Real Estate Listings > Settings > Maps Settings.
    • Select the map provider (Google Maps or Leaflet).
  2. API Key for Google Maps:
    • If using Google Maps, enter your Google Maps API key.
    • Save your settings.

4. Search Form

You can use the default shortcode for the search form. If you want to display listings with a search form, you can use the shortcodes like this
[rem_search_property fields_to_show="property_price,PostalCode,BedroomsTotal,BathroomsTotalInteger" style="1" columns="3" results_page="CURRENT_PAGE_URL" filters_btn_text=""][rem_bridgeoutput_properties][/rem_search_property]

Make sure to replace CURRENT_PAGE_URL with the actual full URL of the page you’re using these shortcodes.

You can add/edit fields in the search form following this.

5. Shortcode Attributes

[rem_bridgeoutput_properties] shortcode has the following attributes that you can use.

Attribute Default Value Purpose
images_height Specifies the height of the images displayed in the listing.
class col-sm-4 Defines the CSS class for the HTML elements, allowing for custom styling and layout.
masonry disable Enables or disables the masonry layout for the listing grid. When set, it activates masonry layout.
title_fields UnparsedAddress,City,StateOrProvince,PostalCode Specifies which fields to use for generating the title of each listing.
ribbon_field PropertyType Determines which field to use for displaying a ribbon or label on the listing, often used for highlighting the property type.
address_field UnparsedAddress Specifies the field to use for displaying the property’s address in the listing.
price_field ListPrice Defines which field to use for showing the property’s price in the listing.
bed_field BedroomsTotal Specifies the field to display the number of bedrooms in the property.
bath_field BathroomsTotalInteger Specifies the field to display the number of bathrooms in the property.

6. Common Issues

  • Property Data Not Displaying:
    • Verify that your API credentials are accurate.
    • Check if the API is online and reachable.
  • Maps Not Loading:
    • If using Google Maps, make sure the API key is valid and has the required permissions.
  • Image Gallery Issues:
    • Ensure the correct gallery type is selected in the settings.
Quick Navigation
Back To Top