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 external sources or workflows.
  • Integrating property management systems with OnOffice to keep estate data synchronized.
  • Bulk creation of estates by feeding multiple JSON objects through the node in a workflow.

Example: A real estate agency could use this node to automatically add new properties collected from a website 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 operation on Estate, the output JSON has the following structure:

  • success: Boolean indicating if the creation was successful.
  • resourceType: The string "estate".
  • operation: The string "create".
  • data: The response data from OnOffice about the created estate (usually includes the created record details).
  • message: A status message returned by the API confirming the creation.

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 property: If the "Data" field 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 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 set up.
  • OnOffice API errors: The node surfaces API error messages returned by OnOffice. Common issues might include invalid fields or missing required data in the JSON payload.
  • Network errors: If the node cannot reach the OnOffice API endpoint, it will report a network error. Check internet connectivity and firewall settings.
  • Unsupported operations or resources: Attempting to use unsupported combinations will result in clear error messages indicating the unsupported resource or operation.

Links and References

Discussion