OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data. Specifically, it allows users to create, retrieve, update, and delete records related to estates, addresses, and relations between them. The "Estate" resource's "Create" operation enables users to add new estate records by providing structured JSON data describing the estate.

Common scenarios where this node is beneficial include:

  • Automating the addition of new real estate listings into an OnOffice system.
  • Integrating property management workflows where estate data needs to be programmatically created.
  • Synchronizing external databases or CRMs with OnOffice by creating estate entries automatically.

Example use case: A real estate agency uses this node in an automation workflow to create new estate listings whenever a form is submitted on their website, passing the form data as JSON to the node.

Properties

Name Meaning
Data JSON object containing the details of the estate to create. This should conform to the expected structure of an estate record in OnOffice.

Output

The node outputs a JSON array where each item corresponds to an 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 type, here always "estate".
  • operation: The operation performed, here "create".
  • data: The response data from OnOffice API representing the created estate record.
  • message: A status message returned by the API confirming the creation.

If the API call fails, the node throws an error unless configured to continue on failure, in which case the output includes:

  • 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 valid credentials (an API token and secret).
  • The node expects these credentials to be configured in n8n prior to execution.
  • Network access to https://api.onoffice.de/api/stable/api.php is required.

Troubleshooting

  • Invalid JSON in Data Property: If the "Data" property contains malformed JSON, the node will throw an error stating "Data must be a valid JSON". Ensure the JSON syntax is correct before running.
  • API Authentication Errors: If the API token or secret are invalid or missing, the node will fail to authenticate. Verify that the API credentials are correctly set up in n8n.
  • OnOffice API Errors: The node surfaces errors returned by the OnOffice API with messages like "OnOffice API error: ". Check the API documentation or your request data for issues.
  • Network Issues: Errors such as "Network error: " indicate connectivity problems. Confirm network access and proxy settings if applicable.
  • Unsupported Resource or Operation: If an unsupported resource or operation is selected, the node throws an error indicating the unsupported action.

Links and References

Discussion