OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data, specifically estates, addresses, and relations. It supports operations such as creating, retrieving, updating, and deleting records for these resources. The "Address" resource's "Create" operation allows users to add new address records by providing JSON-formatted data.

Common scenarios include automating the creation of address entries in a real estate management system, syncing address data from other sources, or batch-creating multiple addresses via workflows.

Example use case: Automatically create a new contact address in OnOffice when a form is submitted on a website, by passing the form data as JSON to this node.

Properties

Name Meaning
Data JSON object containing the details of the address to create. This should be a valid JSON string representing the address fields and their values.

Output

The node outputs a JSON object with the following structure:

  • success: Boolean indicating if the operation was successful.
  • resourceType: The resource involved, here it will be "address".
  • operation: The operation performed, here "create".
  • data: Contains the response data from the OnOffice API about the created address record.
  • message: A status message returned by the API.

If the API call fails, the output will contain an error message describing the issue.

No binary data output is produced by this node.

Dependencies

  • Requires an API token and secret for authenticating with the OnOffice API.
  • Needs configuration of credentials within n8n to provide these authentication details.
  • Uses HTTP POST requests to the OnOffice API endpoint at https://api.onoffice.de/api/v1.

Troubleshooting

  • Invalid JSON in Data property: If the "Data" input is not valid JSON, the node throws an error "Data must be a valid JSON". Ensure the JSON syntax is correct before running.
  • API Authentication errors: If the API token or secret are incorrect or missing, the node will fail with an authentication error. Verify that the API credentials are correctly configured in n8n.
  • OnOffice API errors: Errors returned by the API include messages from the API response. Check the message for details (e.g., invalid fields, missing required data).
  • Network issues: Network connectivity problems result in a "Network error" message. Confirm network access to the OnOffice API endpoint.
  • Unsupported resource or operation: If the node is misconfigured with unsupported resource-operation combinations, it throws descriptive errors indicating the unsupported action.

Links and References

Discussion