RightmoveADF (Inc. Oversea options)

PHP library for the Rightmove Real Time Property Datafeed. It's based on frozensheep repository, but this one includes oversea features.

Install

To install with Composer:

composer require giwrgos88/rightmove-adf

Or add to a composer.json file:

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

Usage

All 13 of the v1.2.1 API endpoints are supported.

• 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]

Example

<?php
use Frozensheep\RightmoveADF\RightmoveADF;

//create the RightmoveADF object
$objRightmoveADF = new RightmoveADF(CERT_FILE, CERT_PASS, RightmoveADF::TEST);
//$objRightmoveADF = new RightmoveADF(CERT_FILE, CERT_PASS, RightmoveADF::LIVE);

//create a request
$objRequest = $objRightmoveADF->createRequest(RightmoveADF::GetBranchPropertyList);

//set the details for the request
$objRequest->network->network_id = NETWORK_ID;
$objRequest->branch->branch_id = BRANCH_ID;

//send the request
$objResponse = $objRightmoveADF->send($objRequest);

if($objResponse->success){
    //
    //do something with the response
    //
}else{
    print_r($objResponse->errors);
}

Rightmove will provide you with a PEM certificate/password and Network ID to use in the requests.

All values that you set will be checked against what the API expects and return exceptions if the wrong data type is set.

Todo

• Add in option to set verbose mode on the request to help track errors with certificates.
• Add in a pre-send validation check for required fields.

Known Issues

None.

Please submit any to the Github repo.