Git Product home page Git Product logo

rightmove-adf's Introduction

RightmoveADF

PHP library for the Rightmove Real Time Property Datafeed.

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.

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.

Installation using Composer

To install with Composer:

composer require jedkirby/rightmove-adf

Or add to a composer.json file:

"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.

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

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

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.

rightmove-adf's People

Contributors

jedkirby avatar sam-r avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.