Arthur Online API
Overview
The ArthurOnline API Addon lets you integrate your WordPress website with the ArthurOnline property management system. This addon enables you to fetch and display property data using a shortcode and manage API authentication settings directly from the WordPress admin panel.
Installation
- Upload the plugin files to the
/wp-content/plugins/directory. - Activate the plugin through the ‘Plugins’ menu in WordPress.
- Navigate to Real Estate Manager > ArthurOnline API to configure the API.
Setup Instructions
1. Create an Application in ArthurOnline
- Go to OAuth Applications under the Your Account section in Arthur Settings.
- Click Add Application and fill in the required details.
- Set the Callback URL.
- Click Save to generate the Client ID and Client Secret.
2. Authenticate with ArthurOnline API
- Go to Settings > ArthurOnline API in WordPress.
- Enter your Client ID and Client Secret.
- Click Authenticate.
- Once authenticated, an Access Token will be saved.
3. Configure API Settings
- After authentication, you can configure additional settings such as the X Entity ID.
- Click Save Settings to apply changes.
Shortcode: [rem_arthuronline_properties]
This shortcode displays properties fetched from the ArthurOnline API.
Attributes
| Attribute | Description | Default Value |
|---|---|---|
images_height |
Height of the property images | (empty) |
class |
CSS class for the property container | col-sm-4 |
masonry |
Enable masonry layout (yes or no) |
(empty) |
title_fields |
Fields to display in the title | portal_address |
ribbon_field |
Field used for the ribbon label | unit_type |
address_field |
Field used for the address display | full_address |
price_field |
Field used to show the price | deposit_amount |
bed_field |
Number of bedrooms field | bedrooms |
bath_field |
Number of bathrooms field | bathrooms |
total_properties |
Number of properties to display | 6 |
unit_status |
Filter properties by status | Available To Let |
Example Usage
[rem_arthuronline_properties total_properties="10" price_field="rent_amount" unit_status="Available To Let"]This will display 10 available properties, showing the rent_amount as the price.