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" 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 in OnOffice.

Output

The node outputs a JSON object with 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: Contains the response data from OnOffice about the created estate record.
  • message: A status message returned by the OnOffice API.

The output is wrapped as an array of JSON objects, one per input item processed.

No binary data output is produced by this node.

Dependencies

  • Requires an API token and secret credential for authenticating with the OnOffice API.
  • The node makes HTTP POST requests to the OnOffice API endpoint at https://api.onoffice.de/api/latest/api.php.
  • Proper configuration of the API credentials within n8n is necessary for successful operation.

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 prefixed with "OnOffice API error:". Check the message for details such as authentication issues, missing required fields, or invalid data formats.
  • Network Issues: Network errors are reported as "Network error: ". Verify network connectivity and that the API endpoint is reachable.
  • Unsupported Resource or Operation: If the resource or operation is not supported, the node throws an error indicating the unsupported action.
  • Filter Parsing Errors: For operations involving filters (not relevant for create but for getMany), invalid JSON in filter parameters causes errors.

To resolve these issues:

  • Validate all JSON inputs carefully.
  • Confirm API credentials are correct and have sufficient permissions.
  • Review the OnOffice API documentation for required fields and data formats.
  • Ensure stable internet connection and access to the API endpoint.

Links and References

Discussion