AgentBox

The AgentBox data sources allows you to show data from the AgentBox real estate API.
Data is provided as JSON which you can map using JSONPath expressions. 

Agentbox – Listings
Provides data from property listings

Agentbox – Staff Members
Provides data on staff members, such as agent profiles

Requirements

A Smartsign AgentBox template data source license

Sandbox API credentials (Client ID and API Key) from AgentBox. Required for each individual client (Individual client instances may be a multi-office group or a single office depending on the client configuration)

Screens must be able to reach https://realestate-au.smartsigncloud.net.

note

For security reasons this data source will not work on legacy hardware due to insufficient support for modern encryption standards.

Please see Legacy Hardware Support for affected devices.

On premise only

AgentBox works the same way for on premise installations, with the same license check. It needs internet access to Smartsign's cloud services.

Setting up the datasource

• Go to Templates -> Datasources.
• Select Add datasource -> Create new.
• Choose Agentbox - Listings or Agentbox - Staff Members and click Select. Without a license, License status shows No license and Select is disabled.
• Enter a name and description and the settings below, then click Create.

Configuration

Setting	Description	Example
Client ID	The client id sandbox credential. The value is masked.	eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9
API Key	The API Key sandbox credential. The value is masked. Available once Client ID is filled in.	acc0-4fb8-84bd-460d-aeb6-e64c-1e74-9911
Office	Select the office that you want to fetch data for. Once the credentials are entered, the drop-down lists the offices by name. If the credentials are wrong, a message says "Oops! Something went wrong. It seems there is an issue with your client ID or API key."	Head Office
Filter	Add additional filters such as ‘Type’, ‘Role’, ‘MarketingStatus’ etc. Standard URL query string, with '&' between each parameter. The leading '&' is optional. Each parameter must be filter[name], limit, include, page, orderBy or order, with a value, otherwise "Invalid Agentbox filter." is shown. Please refer to AgentBox API documentation for supported parameters.	&filter[type]=Sale &filter[role]=Property Management (staff)

Data binding

Text elements use JSONPath value, with optional Parse date, Prefix and Suffix. Image elements use JSON - Image. Show progress and Data transformation script are set per template in Template Creator, under Datasource settings for this template.