intellirent-sdk-php

Intellirent SDK is a library written in PHP that enable an application to interact with the Intellirent (IR) API

Version

TODO

Requirements

• PHP 5.4.0 and later
• PHP Curl extension
• PHP MBString extension
• PHP JSON extension

Installation

To install via Composer, add the following to composer.json:

{
    "require": {
        "homebaseai/intellirent-sdk-php": "dev-master"
    },
    "repositories": [
        {
            "type": "vcs",
            "url": "[email protected]:HomebaseAI/IntellirentSDK.git
        }
    ]
}

Quickstart

Before attempting to use this SDK, you should secure API credentials as follow:

Property Synidcation

This API requires a security_token and a company-name, which a partner will get by contacting IR support.

Single Sign On Integgration

This API uses a security_token, which a partner will get by contacting IR admin.

Applicant Report

This API uses a security_key, which will be shared with any entity who wishes to use our API.

Please follow the installation procedure

Get Started

Configuring the SDK

use IntellirentSDK\Configuration;

# Other Credential as required by IR API
# This is required in the PropertyApi
Configuration::setCompanyId('your-company-id');

# This is needed for all APIs request
Configuration::setSecurityToken('your-security-token');

# For Mock Server
Configuration::setBaseUrl('https://private-anon-396a0e7408-intellirent.apiary-mock.com');

# For production
Configuration::setBaseUrl('https://syndication.irapp.co');

Documentation for APIs

All URIs are relative to {base_url}/api/v2
All Classes are in IntellirentSDK\Apis namespace

Class	Method	HTTP request	Description
ApplicantApi	createApplicant	POST /applicants
ApplicantApi	updateApplicant	PUT /applicants
ApplicantApi	signIn	POST /applicants/:sso_hash
ApplicantReportApi	getApplicantsCount	GET /applicants_count
PropertyApi	listAllProperties	GET /:company_id/properties
PropertyApi	createProperty	POST /:company_id/properties
PropertyApi	updateProperty	PUT /:company_id/properties/:property_id
PropertyApi	archiveProperty	DELETE /:company_id/properties/:property_id
ReferralContactApi	createReferralContacts	POST /create_referral_contacts

Documentation for Models

• Agent
• Applicant
• ApplicantCount
• ApplicantReport
• ApplicantResponse
• NewPropertyResponse
• Property
• PropertyList

Running tests

composer install
./vendor/bin/phpunit tests

Changelog

TODO

License

TODO