OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data. Specifically, for the "Estate" resource and the "Create" operation, it allows users to create new estate records by sending structured JSON data representing the estate 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 other systems or workflows.
  • Integrating property management software with OnOffice to keep estate data synchronized.
  • Bulk creation of estates by feeding multiple JSON objects through n8n workflows.

Example: A real estate agency could use this node to automatically add new properties submitted via a web form directly into their OnOffice database without manual entry.

Properties

Name Meaning
Data JSON object containing the details of the estate to create. This should be a valid JSON structure matching the expected schema of an estate record in OnOffice.

Output

The node outputs a JSON array where each item corresponds to one input item processed. For the "Create Estate" operation, the output JSON has the following structure:

  • 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 record.
  • message: A status message returned by the OnOffice API.

No binary data output is produced by this node.

Dependencies

  • Requires an API token and secret for authenticating with the OnOffice API.
  • The node uses HMAC signature generation for request authentication.
  • The base URL for the API is https://api.onoffice.de/api/latest/api.php.
  • Proper credentials must be configured in n8n to allow authenticated requests.

Troubleshooting

  • Invalid JSON in Data: If the "Data" property contains invalid JSON, the node will throw an error stating "Data must be a valid JSON". Ensure the JSON syntax is correct before running.
  • API Errors: If the OnOffice API returns an error, the node surfaces the message, e.g., "OnOffice API error: ". Check the API token, secret, and the correctness of the data payload.
  • Network Issues: Network errors are reported as "Network error: ". Verify network connectivity and API endpoint accessibility.
  • Unsupported Resource or Operation: If the resource or operation is not supported, the node throws an error indicating the unsupported action.
  • Filter Parsing Errors: Although not relevant for create operation, filters used in other operations must be valid JSON or an error will occur.

Links and References


If you need further details on other operations or resources, feel free to ask!

Discussion