onOffice icon

onOffice

Consume onOffice API

Actions14

Overview

This node integrates with the onOffice API to perform various operations related to real estate data management. Specifically, for the Search resource and Estate operation, it allows users to search for real estate listings using either simple keyword searches or advanced criteria such as price range, location, estate type, and status.

Common scenarios where this node is beneficial include:

  • Real estate agencies wanting to automate retrieval of property listings matching specific client requirements.
  • Market analysis workflows that need to gather filtered estate data from onOffice.
  • Integrations where estate data needs to be fetched dynamically based on user input or other triggers.

Practical example:

  • A workflow that takes user input keywords or detailed filters (e.g., minimum price, city, estate type) and returns a list of matching properties for further processing or notification.

Properties

Name Meaning
Search Type Type of search to perform:
- Simple: Search with simple keywords
- Advanced: Search with advanced criteria
Keywords Keywords to search for (used only if Search Type is Simple)
Search Criteria Advanced search criteria including:
- Minimum Price (number)
- Maximum Price (number)
- City (string)
- Postal Code (string)
- Estate Type: Apartment, House, Commercial, Land
- Status: Active, Inactive, Sold, Reserved
Limit Maximum number of results to return (number, minimum 1)

Output

The node outputs an array of JSON objects representing estates matching the search criteria. Each object contains estate data fields returned by the onOffice API, augmented with a resourceType field set to "search".

Typical fields in each estate record may include identifiers, pricing, location details, estate type, and status, depending on the API response.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the onOffice API.
  • The node makes HTTP POST requests to https://api.onoffice.de/api/stable/api.php.
  • HMAC SHA256 signing is used for request authentication, requiring both an API token and secret.
  • Proper configuration of the API credentials within n8n is necessary.

Troubleshooting

  • No credentials provided: The node will throw an error if the required API credentials are missing. Ensure the API key and secret are configured correctly.
  • Invalid resource or operation: If the resource or operation parameters are incorrect, the node throws an error indicating invalid inputs.
  • API errors: If the onOffice API returns an error status code, the node surfaces the message. Common causes include invalid parameters or exceeded rate limits.
  • No results found: If no estates match the search criteria, the node returns a success message with no records.
  • Parsing errors: If the API response format changes or is unexpected, the node may fail to parse results properly.

To resolve issues:

  • Verify all input parameters are correct and complete.
  • Check API credentials and permissions.
  • Review API usage limits and ensure compliance.
  • Use the "Continue On Fail" option to handle errors gracefully in workflows.

Links and References

Discussion