jedkirby/rightmove-adf

PHP library for the Rightmove Real Time Property Datafeed (ADF).

RightmoveADF

PHP library for the Rightmove Real Time Property Datafeed., _(*1)

Install

Prerequisites

To use this package, you need to: * Be running PHP 5.4 or above * Be using composer (if you want to follow the installation guide) * Rightmove will provide you with a PEM certificate/password and Network ID to use in the requests. You should also have a Branch ID., _(*2)

Note that this package's dependencies will also be installed. Check the composer.json file from the repository if you want to see what these are before using it., _(*3)

Installation using Composer

To install with Composer:, _(*4)

composer require jedkirby/rightmove-adf

Or add to a composer.json file:, _(*5)

"require": {
    "jedkirby/rightmove-adf" : "1.*"
}

Usage

Using the Examples

Examples are provided. It's recommended that you setup one of the examples to see how to interact with the library before continuing., _(*6)

• Install this package using composer as outlined above.
• create a directory for your project for example public_html

mkdir public_html

• copy the example code to the new public_html directory

cp -R vendor/jedkirby/rightmove-adf/examples/ public_html/

• copy the config file to a working Version

cp public_html/config.php.example public_html/config.php

• Edit the config file with your settings. You'll need to have a .pem file form RightMove with your Real Time Data Feed key in it, as well as your network and branch information.
• run the local web server

cd public_html

php -S localhost:8000

• run one of the example files from you browser (eg http://localhost:8080/getBranchPropertyList.php)

Available Methods

All values that you set in the configuration will be checked against what the API expects and return exceptions if the wrong data type is set., _(*7)

All 13 of the v1.2.3 API endpoints are supported., _(*8)

• SendProperty [Example]
• RemoveProperty [Example]
• GetBranchPropertyList [Example]
• AddPremiumListing [Example]
• AddFeaturedProperty [Example]
• RemoveFeaturedProperty [Example]
• GetPropertyPerformance [Example]
• GetBranchPerformance [Example]
• GetBrandEmails [Example]
• GetBranchEmails [Example]
• GetBrandPhoneLeads [Example]
• GetBranchPhoneLeads [Example]
• GetPropertyEmails [Example]

Todo

• Add in a pre-send validation check for required fields.

Known Issues

• The rightmove media crawler doesn't work over Lets Encrypt https and will just return an MED_00001 error.