realestateconz/api-client

Realestate.co.nz Api Client

Maintainers

Details

github.com/realestateconz/realestate-api-php-client

Homepage

Source

Issues

Installs: 7 710

Dependents: 1

Suggesters: 0

Security: 0

Stars: 3

Watchers: 27

Forks: 2

Open Issues: 1

1.1.0 2023-05-16 22:14 UTC

MIT 1b7415a55ded52929dee1f1fe81dd2d99c34ba84

apiclientpropertyrealestate.co.nzlistings

This package is not auto-updated.

Last update: 2024-05-11 12:15:16 UTC

README

The easiest way to work with the realestate.co.nz api client is when it's installed as a Composer package inside your project.

If you're not familiar with Composer, please see http://getcomposer.org/.

  1. Add realestateconz/api-client to your application's composer.json.

     {
     ...
     "require": {
         "realestateconz/api-client": "dev-master"
     },
     ...
 }

  2. Run composer install.

  3. If you haven't already, add the Composer autoload to your project's initialization file. (example)

     require 'vendor/autoload.php';

Creating API Signatures

GET Request

$client = new RealestateCoNz_Api_Client('PRIVATE_KEY', 'PUBLIC_KEY', 1);
$api_path = '/listings/';
$query_params = array('format' => 'full');
$api_signature = $client->createSignature($api_path, $query_params);

POST Request

$client = new RealestateCoNz_Api_Client('PRIVATE_KEY', 'PUBLIC_KEY', 1);
$api_path = '/listings/100000000/agent-enquiry/';
$query_params = array();
$post_values = array('email' => 'example@example.com', 'phone' => '000000000', 'text' => 'test', 'name' => 'Test');
$api_signature = $client->createSignature($api_path, $query_params, $post_values);

Note: all post requests must be sent with the following request header:

Content-Type: application/x-www-form-urlencoded