Docs
< All Articles
Print

RealWorks API

Posted
Updated

1. Introduction

The RealWorks API Integration Plugin allows you to fetch property listings from the RealWorks API and sync them with your WordPress website. With this plugin, you can:

  • Automatically schedule imports of property listings.
  • Dynamically map specific fields from the API to REM custom fields.
  • Customize titles, content, and other meta information for each property.

2. Plugin Installation

  1. Download the Plugin: Download the RealWorks API Integration Plugin .zip file.
  2. Install the Plugin:
    • Go to your WordPress Dashboard.
    • Navigate to Plugins > Add New.
    • Click Upload Plugin, select the .zip file, and click Install Now.
    • Once installed, click Activate.
  3. Configure the Plugin: After activation, you’ll find a new menu item in the Real Estate Manager called “RealWorks API.” Navigate there to start configuring the plugin.

3. Getting the API Access Token

Before using the plugin, you need an Access Token from the RealWorks API.

  1. Log in to your RealWorks Developer Account and navigate to the Developer ID Section.
  2. Copy the developer ID and provide it to your broker.
  3. They will give you an Access Token and keep it handy for the plugin setup.
  4. If you’re still not sure, just login to your developer account and open this link. It will guide you with the screenshots.
    https://developers.realworks.nl/#/documentation

4. Plugin Setup

Access Token

Once you have the Access Token, follow these steps to set up the plugin:

  1. Go to the WordPress Dashboard.
  2. Navigate to Real Estate Manager -> RealWorks API.
  3. Under the Access Token field, paste your API token.

Number of Listings

Define how many listings to fetch in each API call:

  1. In the Number of Listings field, enter the number of properties you’d like to fetch at a time (e.g., 10, 20, etc.).

Schedule Settings

You can schedule automatic imports for your listings:

  1. Choose a schedule option:
    • Once a day
    • Twice a day
    • Hourly

The plugin will automatically fetch listings based on your selected schedule.

5. Mapping Fields

The most powerful feature of this plugin is the ability to map data fields from the API to REM fields in WordPress.

Property Title Mapping

You can define how property titles will be created from the API data using dotted notation.

  1. In the Title Mapping field, enter the keys you want to use for the title. For example:
    • object.type.objecttype will use the object type as the title.
    • adres.straat will append the street name to the title.

    These keys should match the field structure of the API response.

The plugin will dynamically construct the property title based on the API data.

Content Mapping

Similarly, you can map specific fields for the property description.

  1. In the Content Mapping field, provide the dotted key that corresponds to the API field for the property content. For example:
    • teksten.aanbiedingstekst for the property description.

This allows you to customize what appears in the content section of the property listing.

Property Fields Mapping

For each property field you want to import, you can map it to a REM custom field:

  1. Scroll to the Field Mapping Section: Here you’ll see all the available WordPress fields (e.g., price, address, status).
  2. Enter API Keys: In the RETS Key Name column, manually enter the API key path for each WordPress field. For example:
    • For the price, you may use financieel.koopprijs.
    • For status, you may use financieel.status.

If you leave any field blank, that field will not be updated during the import process.

6. Importing Properties

You can manually trigger the property import at any time:

  1. Navigate to Real Estate Manager -> RealWorks API.
  2. Scroll to the Import Section.
  3. Click the Import Now button to trigger a manual import.

The plugin will display a loading indicator and import the latest properties.

7. Monitoring Imports

You can track the progress of your imports and see when the next import will run:

  1. The Next Import Time field will show when the next scheduled import is set to occur.
  2. The Last Run Report will provide a summary of the last import, including:
    • Number of properties created.
    • Number of properties updated.
    • Errors (if any).

8. Error Handling

If any errors occur during the import process, they will be logged in the Last Run Report.

  • Common errors include missing or invalid API tokens, improperly mapped fields, or network issues.
  • Review the Error Messages section for details on what went wrong during the import.

You can adjust your settings and run the import again if errors are encountered.

9. Troubleshooting

Here are some common troubleshooting tips:

  • API Connection Issues: Double-check your access token to ensure it is valid.
  • Incorrect Data Mapping: Ensure that the keys in the mapping fields exactly match the structure of the API response.
  • Scheduled Imports Not Running: Make sure that your WordPress cron jobs are running correctly. You can use a plugin like WP Crontrol to monitor scheduled tasks.
Quick Navigation
Back To Top