OnOffice

Consume OnOffice API
Join our community

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data. Specifically, for the Estate - Create operation, it allows users to create new estate records by sending structured JSON data representing the estate's details to the OnOffice system.

Common scenarios where this node is beneficial include:

  • Automating the addition of new real estate listings into the OnOffice platform from external sources or forms.
  • Integrating property management systems with OnOffice to keep estate data synchronized.
  • Bulk importing estates by feeding multiple JSON objects through n8n workflows.

Example use case: A real estate agency collects property information via a web form and uses this node to automatically create corresponding estate entries in their OnOffice database.

Properties

Name Meaning
Data JSON object containing the details of the estate to create. This should follow the OnOffice API schema for an estate record. Example fields might include title, description, price, location, etc.

Output

The node outputs a JSON array where each item corresponds to one input item processed. For the create operation on estates, the output JSON structure includes:

  • success: Boolean indicating if the creation was successful.
  • resourceType: The resource involved, here always "estate".
  • operation: The operation performed, here "create".
  • data: The response data from OnOffice about the created estate, typically including the new estate's ID and any other returned metadata.
  • message: A status message from the API confirming the creation.

If the API call fails and "Continue On Fail" is enabled, the output will contain an error object with:

  • success: false
  • error: Error message describing what went wrong.
  • resourceType and operation for context.

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to the OnOffice API using an API token and secret (configured as credentials in n8n).
  • The node sends HTTP POST requests to the OnOffice API endpoint at https://api.onoffice.de/api/latest/api.php.
  • Proper API credentials must be set up in n8n before using this node.

Troubleshooting

  • Invalid JSON in Data Property: If the JSON provided in the "Data" field is malformed, the node throws an error stating "Data must be a valid JSON". Ensure the JSON syntax is correct.
  • API Authentication Errors: If the API token or secret are incorrect or expired, the node will return an API error message. Verify credentials in n8n settings.
  • Unknown API Errors: The node surfaces messages returned by the OnOffice API. Check the message for clues, such as missing required fields or invalid values.
  • Filter Parsing Errors: Although not relevant for create, other operations that accept filters require valid JSON; otherwise, errors occur.
  • Network Issues: Network connectivity problems result in "Network error" messages. Confirm internet access and API availability.

Links and References

Discussion