Zoddak

Token Authentication

You need to provide us with the IP address of the server that will use the service in order to make requests to our API, to download the feed in XML or JSON format or for using the wordpress plugin.

You can find the token for your agency in the "My services" section of "My Account" in our platform.

General Information

The documentation is not available in the feed, the API or the wordpress plugin, these services are designed to show information about new developments on your website to your end customers. Their main objective is to generate interest and capture the attention of potential customers, encouraging them to contact your agency. It is not intended to provide all the project documentation.

In many cases, the documents provided by the marketers or developers contain detailed information, including text and graphics, which could lead a customer to go directly to the sales office without first contacting your agency. Therefore, we want to ensure that the agency is the primary point of contact for potential buyers.

Download

The plugin can be downloaded here: Zoddak wp plugin new_devs (zip file)

Introduction

The "Zoddak New Developments Connector" plugin allows you to connect your WordPress website with the Zoddak API to display real estate properties from new developments in a professional and responsive manner. This plugin is designed to work in multiple languages, including Spanish, English, French, and Dutch, offering an optimized user experience for different international markets.

• - Display of property listings with customizable design
• - Details page for each property
• - Search form with filters
• - Complete customization of colors and styles
• - Integration with contact forms

Installation

To install the plugin in your wordpress site, follow these steps:

• 1. Download the ZIP file for the plugin from the download button at the bottom of this page.
• 2. In your WordPress admin panel, go to "Plugins" > "Add new" > "Upload plugin".
• 3. Select the downloaded ZIP file and click "Install now".
• 4. Once installed, click "Activate plugin".
• 5. After activation, a new menu will appear in the sidebar called "Properties Display".

General Configuration

To configure the connection with the Zoddak API, follow these steps:

• 1. Go to "Properties Display" in the sidebar menu of the admin panel.
• 2. In the "API Configuration" section, complete the following fields:
  • - Custom Path: Define the base URL to display properties on your website. By default it is "properties", which means your properties will be available at www.yourdomain.com/properties/. You can change it according to your preferences, for example, "real-estate" or "developments".
  • - API URL: The address of the Zoddak API server. By default it is "http://23.26.96.62:5007". Do not modify this value unless Zoddak specifically tells you to do so.
  • - API Key: Enter the API key provided by Zoddak. This key is essential to access the property data. If you don't have a key, contact Zoddak to obtain one.
  • - Items per Page: Define how many properties will be displayed per page in the listing. The recommended value is between 9 and 12 for optimal display.
  • - Restrict to Administrators: Activate this option if you want only site administrators to be able to view the property pages. Useful during initial setup or for sites under development.
• 3. Click "Save changes" to apply the configuration.

Display Configuration

The display of properties is automatically configured once the connection with the API is established. The plugin will create:

• - A property listing page at the custom path you have defined.
• - Individual pages for each property, accessible from the listing.

Contact Form Configuration

To integrate a contact form on the details page of each property:

• 1. Install and configure your preferred contact form plugin (such as Contact Form 7, WPForms, etc.).
• 2. Create a specific contact form for properties.
• 3. In the "API Configuration" section of Properties Display, find the "Contact Form Shortcode" field.
• 4. Enter your form's shortcode (for example, `[contact-form-7 id="123" title="Contact Form"]`).
• 5. Save the changes.

The form will appear on the details page of each property, allowing visitors to contact about a specific property.

Property Card Design

To customize the appearance of property cards:

• 1. Go to "Properties Display" > "Customization" in the sidebar menu.
• 2. In the "Card Design" section, you will find the following options:
  • - Property Layout: Choose between "Vertical" (traditional card format) or "Horizontal" (list format with image on one side).
  • - Card Size: Select between "Small", "Medium" or "Large" to adjust the size of the property cards.
  • - Card Background Color: Choose the background color for property cards. A light color is recommended for better readability.
• 3. Click "Save changes" to apply the configuration.

Text Sizes and Styles

To customize the property texts:

• 1. On the same "Customization" page, you will find the "Text Sizes" section:
  • - Text Size: Adjust the general text size on property cards.
  • - Description Text Size: Specifically adjust the size of the property description text.
• 2. Save the changes to apply the configuration.

Colors and Appearance

To customize colors and general appearance:

• 1. On the "Customization" page, you will find various color options:
  • - View Details Button Color: Defines the color of the main button that leads to the property details page.
  • - Property Type Background Color: Background color for the label that shows the property type (apartment, villa, etc.).
  • - Property Type Text Color: Text color for the property type label.
  • - Pagination Hover Color: Color that appears when hovering over pagination buttons.
  • - Current Page Color: Color that highlights the current page in pagination.
  • - Page Width: Adjust the maximum width of the properties container. It can be "Full" (100%), "Wide" (1200px), "Standard" (1000px) or "Narrow" (800px).
• 2. Save the changes to apply the configuration.

Search Menu

To customize the search menu:

• 1. Go to "Properties Display" > "Color Customization" in the sidebar menu.
• 2. Configure the "Search Menu Background Color" according to your preferences.
• 3. Save the changes.

Search and Reset Buttons

To customize the search form buttons:

• 1. On the same "Color Customization" page:
  • - Search Button Color: Defines the color of the main search button.
  • - Reset Button Color: Defines the color of the button to reset search filters.
• 2. Save the changes to apply the configuration.

Property Listing Display

Once the plugin is configured, the property listing will be available at the custom path you have defined (by default: www.yourdomain.com/properties/).

• - Displays properties in the selected card format (vertical or horizontal)
• - Includes images, prices, locations, and main features
• - Offers pagination to navigate through all available properties
• - Provides a search form to filter properties

Property Details Display

By clicking on a property in the listing or on the "View Details" button, you access the details page of the specific property.

• - Image gallery with expandable viewer
• - Detailed property information (price, location, area, bedrooms, etc.)
• - Complete description
• - Location map (if coordinates are available)
• - Contact form (if configured)
• - Information about available units (if applicable)

Search Form

The search form allows visitors to filter properties according to various criteria:

• - Price range (minimum and maximum)
• - Number of bedrooms
• - Property type
• - Area or location

To use the form:

• 1. Select the desired filters
• 2. Click "Search"
• 3. The listing will update showing only the properties that match the selected criteria
• 4. To remove all filters, click "Reset"

Troubleshooting

Properties are not displayed

• 1. Verify that the API key is correct and active.
• 2. Check the connection with the API server (API URL).
• 3. Make sure you don't have the "Restrict to Administrators" option activated if you want the properties to be visible to all visitors.
• 4. Verify that WordPress rewrite rules are working correctly. You can go to Settings > Permalinks and simply save again to regenerate these rules.

Display issues

• 1. If property cards are not displaying correctly, try different card sizes and layouts (vertical/horizontal).
• 2. Check for conflicts with the WordPress theme or other plugins that may be affecting the CSS.
• 3. Try adjusting the page width to better fit your theme.

Contact form doesn't work

• 1. Verify that the contact form shortcode is correct.
• 2. Make sure the contact form plugin is correctly configured and working on other pages.
• 3. Ensure that the SMTP system is correctly configured in your WordPress installation, as incorrect configuration can prevent sending emails from forms.