SlideShare a Scribd company logo
Advanced
Customization
@Antonioortegajr
@AleckIDX
Create custom tools with the
IDX Broker API
Multiple saved links
• The creation of saved links in the
IDX broker system is a very
common task.
• An iteration of saved links in an city,
subdivision, or area by price range
is great for SEO, but time-
consuming.
• Customization goes beyond client-
side cosmetics and can be applied
with tools making set-ups easier.
Multiple Saved Links
•Let's create a saved link
Multiple Saved Links
•Let's create a saved link
•Then create a range of
saved links.
PUT, POST, and DELETE
Available as of version
1.1 of the IDX Broker API
is the addition of the
PUT, POST, and DELETE
methods for Saved Links.
PUT, POST, and DELETE
With this method you can:
• Create new saved links via the
API
• Modify existing saved links via
API call
• Delete save links via API call
PUT, POST, and DELETE
• All saved links are question mark
(?) and ampersand (&)
delineated.
• While a GET call will return these
? and & strings, all PUT and POST
API calls should create and array
and encode.
PHP Example
$data = array(
'linkName'=> 'Good_side_of_tracks',
// the link's url
'pageTitle'=>'Good_side_of_tracks',
// the title tag
'linkTitle'=>'Good_side_of_tracks',
// how the link displays
'queryString'=>array('idxID'=>'a001','hp'=>200000)
);
$data = http_build_query($data);
// encode and & delineate
PUT, POST, and DELETE
• Of saved links created via API,
there is a limit of 1000.
• This is to prevent abuse of
programmatically creating saved
links.
• If this limit is reached, a status
code of 417 will be returned for
PUT and POST API calls.
DELETE
• This method is to be used at your own
risk.
• We will NOT be held accountable for
programmatic errors in your code or the
improper use of search values or
options within said values resulting in
broken saved links.
• A successful call will require the ID of
the saved link to be deleted. This will
return 204 upon success.
Create a Price Range of Saved Links
Choose a saved link to create
a price range of saved link
The output will be the saved link
with hp and lp ranges set to:
100000 to 200000
200000 to 300000
300000 to 400000
400000 to 500000
http code: 200
Range of Saved Links
Link Name: Rental
Link Query: page=homes&idxsrp=4512
&city[]=1316&ccz=city &aw_address=123+fake
UID: 2120-78368
Create price range links from this link
Range of Saved links
saved link ID = 2120-78368
url string = page=homes&idxsrp=4512&city[]=1316
&ccz=city&aw_address=123 fake link name = Rental
Returned code: 200
If 200 returned the link Rental100000to200000 was added
Returned code: 200
If 200 returned the link Rental200000to300000 was added
Returned code: 200
If 200 returned the link Rental300000to400000 was added
Returned code: 200
If 200 returned the link Rental400000to500000 was added
Add Leads from a CSV via API
Adjusting a CSV in Excel
Map fields from CSV to API call
Add 100 Leads with Bulk Lead PUT method
// access URL and request method
$url = 'https://api.idxbroker.com/leads/bulklead';
$data = array( 'firstName[0]'=>'Aaron', 'lastName[0]'=>'Aaronson', 'email[0]'=>'aaaaaaaaaronson@fake-
email.com',
'firstName[1]'=>'Alan', 'lastName[1]'=>'Aaronson', 'email[1]'=>'alanaaronson@fake-site.com' );
$data = http_build_query($data); // encode and & delineate $method = 'PUT'; // headers (required and
optional) $headers = array( 'Content-Type: application/x-www-form-urlencoded', // required 'accesskey:
abcdefghijklmnopqrstuvwx', // required - replace with your own 'outputtype: json' // optional - overrides the
preferences in our API control page ); // set up cURL $handle = curl_init(); curl_setopt($handle,
CURLOPT_URL, $url); curl_setopt($handle, CURLOPT_HTTPHEADER, $headers); curl_setopt($handle,
CURLOPT_RETURNTRANSFER, true); curl_setopt($handle, CURLOPT_SSL_VERIFYHOST, false);
curl_setopt($handle, CURLOPT_SSL_VERIFYPEER, false); if ($method != 'GET') curl_setopt($handle,
CURLOPT_CUSTOMREQUEST, $method); // send the data curl_setopt($handle,
CURLOPT_POSTFIELDS, $data); // exec the cURL request and returned information. Store the returned
HTTP code in $code for later reference $response = curl_exec($handle); $code = curl_getinfo($handle,
CURLINFO_HTTP_CODE); if ($code >= 200 || $code < 300) $response = json_decode($response,true);
else $error = $code;
Front End Use Cases
• We've examined customization
cases using the API.
• Now let's look at some uses of
customization on the front end.
Customization of a
Quick Search
Start with a
basic quick
search widget
Basic CSS
• #IDX-qsIdxID-15288{display:none;}
• #IDX-qsMaxPriceWrap-15288,
#IDX-qsMinPriceWrap-15288,
#IDX-qsMinBedWrap-15288,
• #IDX-qsMinBathWrap-15288{max-
width:25%;}
Add Custom Field
<div id="IDX-quicksearch…">
<form id="IDX-quicksearchForm…">…
< div class="IDX-qsFieldWrap">
<select class="IDX-qsInput IDX-qsSelectInput"
name="a_Style">
<option value="">Style</option>
<option value="Ranch">Ranch</option>
<option value="Duplex">Duplex</option>
</select></div>
…</form>
</div>
CSS Logged In versus
Logged Out
• IDX Broker can have different CSS
rules based on whether or not the
visitor is logged in.
• This can help you to change
content for the public versus
leads.
• Be sure that any changes don't
violate MLS rules.
Logged Out
.IDX-notLoggedIn .IDX-resultsAddressNumber
{display: none;}
.IDX-notLoggedIn .IDX-resultsAddressDirection
{display: none;}
.IDX-notLoggedIn .IDX-resultsAddressName
{display: none;}
.IDX-notLoggedIn .IDX-
resultsEndAddressCommaOne {display: none;}
.IDX-notLoggedIn .IDX-resultsAddressZip::after
{content: " signup to see address";}
Logged In
• Here you can see that
when logged in, the
previous CSS has no
effect and allows the
lead to see all of the
address information.
• You can check out all the example scripts at
GitHub.
• https://github.com/antonioortegajr/
Advanced Customization Alec and Antonio

More Related Content

Viewers also liked (11)

Explore Designer Bedspreads Online at MaddHome
Explore Designer Bedspreads Online at MaddHomeExplore Designer Bedspreads Online at MaddHome
Explore Designer Bedspreads Online at MaddHome
 
ECE_speech_brochure_2016
ECE_speech_brochure_2016ECE_speech_brochure_2016
ECE_speech_brochure_2016
 
The effect of social media comments on consumers’ responses to food safety in...
The effect of social media comments on consumers’ responses to food safety in...The effect of social media comments on consumers’ responses to food safety in...
The effect of social media comments on consumers’ responses to food safety in...
 
Reloj
RelojReloj
Reloj
 
BBFC Certification Research powerpoint
BBFC Certification Research powerpointBBFC Certification Research powerpoint
BBFC Certification Research powerpoint
 
Financial Econometrics_Edmond_Farah
Financial Econometrics_Edmond_FarahFinancial Econometrics_Edmond_Farah
Financial Econometrics_Edmond_Farah
 
Post modernism
Post modernismPost modernism
Post modernism
 
Ht media
Ht mediaHt media
Ht media
 
Thriller opening conventions
Thriller opening conventionsThriller opening conventions
Thriller opening conventions
 
Attique-CV (2)
Attique-CV (2)Attique-CV (2)
Attique-CV (2)
 
Vividness in Lifee
Vividness in LifeeVividness in Lifee
Vividness in Lifee
 

More from IDX Broker (7)

Bootstrap Marketing
Bootstrap MarketingBootstrap Marketing
Bootstrap Marketing
 
Audience
AudienceAudience
Audience
 
Who
WhoWho
Who
 
Welcome from Chad
Welcome from ChadWelcome from Chad
Welcome from Chad
 
IDX Broker Research & Development by Derek Rose
IDX Broker Research & Development by Derek RoseIDX Broker Research & Development by Derek Rose
IDX Broker Research & Development by Derek Rose
 
IDX API with Antonio
IDX API with AntonioIDX API with Antonio
IDX API with Antonio
 
Equity WordPress framework with Chad and Dave
Equity WordPress framework with Chad and DaveEquity WordPress framework with Chad and Dave
Equity WordPress framework with Chad and Dave
 

Recently uploaded

Listing Turkey - Sinpaş Queen Bomonti Katalog
Listing Turkey - Sinpaş Queen Bomonti KatalogListing Turkey - Sinpaş Queen Bomonti Katalog
Listing Turkey - Sinpaş Queen Bomonti Katalog
Listing Turkey
 
Purvanchal Skyline Vista is commercial Project in Sector 94 Noida.
Purvanchal Skyline Vista is commercial Project in Sector 94 Noida.Purvanchal Skyline Vista is commercial Project in Sector 94 Noida.
Purvanchal Skyline Vista is commercial Project in Sector 94 Noida.
vivekpalprc
 
Property Rental Cumbria North West Guide
Property Rental Cumbria North West GuideProperty Rental Cumbria North West Guide
Property Rental Cumbria North West Guide
AskXX.com
 

Recently uploaded (20)

Elegant Evergreen Homes - Timeless Luxury in Yelahanka, Bangalore
Elegant Evergreen Homes - Timeless Luxury in Yelahanka, BangaloreElegant Evergreen Homes - Timeless Luxury in Yelahanka, Bangalore
Elegant Evergreen Homes - Timeless Luxury in Yelahanka, Bangalore
 
Kohinoor Dhanori Apartments Pune Brochure
Kohinoor Dhanori Apartments Pune BrochureKohinoor Dhanori Apartments Pune Brochure
Kohinoor Dhanori Apartments Pune Brochure
 
MC Heights-Best Construction Company in jhang
MC Heights-Best Construction Company in jhangMC Heights-Best Construction Company in jhang
MC Heights-Best Construction Company in jhang
 
Oeiras Tech City, Developed by RE Capital and REIG, Will Become Lisbon's Futu...
Oeiras Tech City, Developed by RE Capital and REIG, Will Become Lisbon's Futu...Oeiras Tech City, Developed by RE Capital and REIG, Will Become Lisbon's Futu...
Oeiras Tech City, Developed by RE Capital and REIG, Will Become Lisbon's Futu...
 
Shapoorji Pallonji Plots Jadhavgadh Fort Pune.pdf
Shapoorji Pallonji Plots Jadhavgadh Fort Pune.pdfShapoorji Pallonji Plots Jadhavgadh Fort Pune.pdf
Shapoorji Pallonji Plots Jadhavgadh Fort Pune.pdf
 
Sefakoy Sinpas Boulevard Istanbul - Presentation
Sefakoy Sinpas Boulevard Istanbul - PresentationSefakoy Sinpas Boulevard Istanbul - Presentation
Sefakoy Sinpas Boulevard Istanbul - Presentation
 
Listing Turkey - Sinpaş Queen Bomonti Katalog
Listing Turkey - Sinpaş Queen Bomonti KatalogListing Turkey - Sinpaş Queen Bomonti Katalog
Listing Turkey - Sinpaş Queen Bomonti Katalog
 
Purvanchal Skyline Vista is commercial Project in Sector 94 Noida.
Purvanchal Skyline Vista is commercial Project in Sector 94 Noida.Purvanchal Skyline Vista is commercial Project in Sector 94 Noida.
Purvanchal Skyline Vista is commercial Project in Sector 94 Noida.
 
Redevelopment in Pune Challenges & Solutions (PPT).pdf
Redevelopment in Pune Challenges & Solutions (PPT).pdfRedevelopment in Pune Challenges & Solutions (PPT).pdf
Redevelopment in Pune Challenges & Solutions (PPT).pdf
 
Bozeman Real Estate Market Reports April/May 2024
Bozeman Real Estate Market Reports April/May 2024Bozeman Real Estate Market Reports April/May 2024
Bozeman Real Estate Market Reports April/May 2024
 
Transforming Your Home Expert Guide to Renovations and Extensions in Upwey
Transforming Your Home Expert Guide to Renovations and Extensions in UpweyTransforming Your Home Expert Guide to Renovations and Extensions in Upwey
Transforming Your Home Expert Guide to Renovations and Extensions in Upwey
 
Commercial Property Management Solutions
Commercial Property Management SolutionsCommercial Property Management Solutions
Commercial Property Management Solutions
 
Avrupa Konutlari Yenimahalle - Listing Turkey
Avrupa Konutlari Yenimahalle - Listing TurkeyAvrupa Konutlari Yenimahalle - Listing Turkey
Avrupa Konutlari Yenimahalle - Listing Turkey
 
Property Rental Cumbria North West Guide
Property Rental Cumbria North West GuideProperty Rental Cumbria North West Guide
Property Rental Cumbria North West Guide
 
Salarpuria Sattva Lakeridge Neopolis Hyderabad.pdf.pdf
Salarpuria Sattva Lakeridge Neopolis Hyderabad.pdf.pdfSalarpuria Sattva Lakeridge Neopolis Hyderabad.pdf.pdf
Salarpuria Sattva Lakeridge Neopolis Hyderabad.pdf.pdf
 
Why Sell With Urban Cool KC - Listing Presentation
Why Sell With Urban Cool KC - Listing PresentationWhy Sell With Urban Cool KC - Listing Presentation
Why Sell With Urban Cool KC - Listing Presentation
 
Listing Turkey - TURKSTAT Corporate - 2024 April
Listing Turkey - TURKSTAT Corporate - 2024 AprilListing Turkey - TURKSTAT Corporate - 2024 April
Listing Turkey - TURKSTAT Corporate - 2024 April
 
2BHK-3BHK NEW FLAT FOR SALE IN TUPUDANA,RANCHI.
2BHK-3BHK NEW FLAT FOR SALE IN TUPUDANA,RANCHI.2BHK-3BHK NEW FLAT FOR SALE IN TUPUDANA,RANCHI.
2BHK-3BHK NEW FLAT FOR SALE IN TUPUDANA,RANCHI.
 
Sinpas Gokorman Presentation. - Listing Turkey
Sinpas Gokorman Presentation. - Listing TurkeySinpas Gokorman Presentation. - Listing Turkey
Sinpas Gokorman Presentation. - Listing Turkey
 
Top 10 International Schools in Bangalore
Top 10 International Schools in BangaloreTop 10 International Schools in Bangalore
Top 10 International Schools in Bangalore
 

Advanced Customization Alec and Antonio

  • 2. Create custom tools with the IDX Broker API
  • 3. Multiple saved links • The creation of saved links in the IDX broker system is a very common task. • An iteration of saved links in an city, subdivision, or area by price range is great for SEO, but time- consuming. • Customization goes beyond client- side cosmetics and can be applied with tools making set-ups easier.
  • 4. Multiple Saved Links •Let's create a saved link
  • 5. Multiple Saved Links •Let's create a saved link •Then create a range of saved links.
  • 6. PUT, POST, and DELETE Available as of version 1.1 of the IDX Broker API is the addition of the PUT, POST, and DELETE methods for Saved Links.
  • 7. PUT, POST, and DELETE With this method you can: • Create new saved links via the API • Modify existing saved links via API call • Delete save links via API call
  • 8. PUT, POST, and DELETE • All saved links are question mark (?) and ampersand (&) delineated. • While a GET call will return these ? and & strings, all PUT and POST API calls should create and array and encode.
  • 9. PHP Example $data = array( 'linkName'=> 'Good_side_of_tracks', // the link's url 'pageTitle'=>'Good_side_of_tracks', // the title tag 'linkTitle'=>'Good_side_of_tracks', // how the link displays 'queryString'=>array('idxID'=>'a001','hp'=>200000) ); $data = http_build_query($data); // encode and & delineate
  • 10. PUT, POST, and DELETE • Of saved links created via API, there is a limit of 1000. • This is to prevent abuse of programmatically creating saved links. • If this limit is reached, a status code of 417 will be returned for PUT and POST API calls.
  • 11. DELETE • This method is to be used at your own risk. • We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in broken saved links. • A successful call will require the ID of the saved link to be deleted. This will return 204 upon success.
  • 12. Create a Price Range of Saved Links Choose a saved link to create a price range of saved link The output will be the saved link with hp and lp ranges set to: 100000 to 200000 200000 to 300000 300000 to 400000 400000 to 500000 http code: 200
  • 13. Range of Saved Links Link Name: Rental Link Query: page=homes&idxsrp=4512 &city[]=1316&ccz=city &aw_address=123+fake UID: 2120-78368 Create price range links from this link
  • 14. Range of Saved links saved link ID = 2120-78368 url string = page=homes&idxsrp=4512&city[]=1316 &ccz=city&aw_address=123 fake link name = Rental Returned code: 200 If 200 returned the link Rental100000to200000 was added Returned code: 200 If 200 returned the link Rental200000to300000 was added Returned code: 200 If 200 returned the link Rental300000to400000 was added Returned code: 200 If 200 returned the link Rental400000to500000 was added
  • 15. Add Leads from a CSV via API
  • 16. Adjusting a CSV in Excel
  • 17. Map fields from CSV to API call
  • 18. Add 100 Leads with Bulk Lead PUT method // access URL and request method $url = 'https://api.idxbroker.com/leads/bulklead'; $data = array( 'firstName[0]'=>'Aaron', 'lastName[0]'=>'Aaronson', 'email[0]'=>'aaaaaaaaaronson@fake- email.com', 'firstName[1]'=>'Alan', 'lastName[1]'=>'Aaronson', 'email[1]'=>'alanaaronson@fake-site.com' ); $data = http_build_query($data); // encode and & delineate $method = 'PUT'; // headers (required and optional) $headers = array( 'Content-Type: application/x-www-form-urlencoded', // required 'accesskey: abcdefghijklmnopqrstuvwx', // required - replace with your own 'outputtype: json' // optional - overrides the preferences in our API control page ); // set up cURL $handle = curl_init(); curl_setopt($handle, CURLOPT_URL, $url); curl_setopt($handle, CURLOPT_HTTPHEADER, $headers); curl_setopt($handle, CURLOPT_RETURNTRANSFER, true); curl_setopt($handle, CURLOPT_SSL_VERIFYHOST, false); curl_setopt($handle, CURLOPT_SSL_VERIFYPEER, false); if ($method != 'GET') curl_setopt($handle, CURLOPT_CUSTOMREQUEST, $method); // send the data curl_setopt($handle, CURLOPT_POSTFIELDS, $data); // exec the cURL request and returned information. Store the returned HTTP code in $code for later reference $response = curl_exec($handle); $code = curl_getinfo($handle, CURLINFO_HTTP_CODE); if ($code >= 200 || $code < 300) $response = json_decode($response,true); else $error = $code;
  • 19. Front End Use Cases • We've examined customization cases using the API. • Now let's look at some uses of customization on the front end.
  • 20. Customization of a Quick Search Start with a basic quick search widget
  • 21. Basic CSS • #IDX-qsIdxID-15288{display:none;} • #IDX-qsMaxPriceWrap-15288, #IDX-qsMinPriceWrap-15288, #IDX-qsMinBedWrap-15288, • #IDX-qsMinBathWrap-15288{max- width:25%;}
  • 22. Add Custom Field <div id="IDX-quicksearch…"> <form id="IDX-quicksearchForm…">… < div class="IDX-qsFieldWrap"> <select class="IDX-qsInput IDX-qsSelectInput" name="a_Style"> <option value="">Style</option> <option value="Ranch">Ranch</option> <option value="Duplex">Duplex</option> </select></div> …</form> </div>
  • 23. CSS Logged In versus Logged Out • IDX Broker can have different CSS rules based on whether or not the visitor is logged in. • This can help you to change content for the public versus leads. • Be sure that any changes don't violate MLS rules.
  • 24. Logged Out .IDX-notLoggedIn .IDX-resultsAddressNumber {display: none;} .IDX-notLoggedIn .IDX-resultsAddressDirection {display: none;} .IDX-notLoggedIn .IDX-resultsAddressName {display: none;} .IDX-notLoggedIn .IDX- resultsEndAddressCommaOne {display: none;} .IDX-notLoggedIn .IDX-resultsAddressZip::after {content: " signup to see address";}
  • 25. Logged In • Here you can see that when logged in, the previous CSS has no effect and allows the lead to see all of the address information.
  • 26. • You can check out all the example scripts at GitHub. • https://github.com/antonioortegajr/

Editor's Notes

  1. Everyone has seen these links. Iterations of an area with price.
  2. Let's look at the process.
  3. csv files from other systems often do no match the fields IDX Broker has in Platinum
  4. csv files from other systems often do no match the fields IDX Broker has in Platinum
  5. We just need to map the csv to json and send
  6. The heavy lifting is done by the provided sample API call