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 looping over datasets in n8n workflows.

Example: A real estate agency could use this node to automatically add new properties received via a form submission 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 string representing all necessary fields for the estate record as expected by the OnOffice API.

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

The output is wrapped in an array suitable for further processing in n8n workflows.

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.
  • Requires configuration of credentials within n8n to provide these API keys securely.

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 from the API response. Common causes include invalid data fields, missing required fields, or authentication issues.
  • Network Issues: Network errors during the HTTP request will result in a "Network error" message. Check connectivity and API endpoint accessibility.
  • Unsupported Resource or Operation: If the resource or operation parameters are incorrect or unsupported, the node throws descriptive errors indicating the unsupported action.

To resolve errors:

  • Validate JSON input carefully.
  • Verify API credentials and permissions.
  • Review API documentation for required fields and constraints.
  • Use the node's "Continue on Fail" option to handle errors gracefully in bulk operations.

Links and References

Discussion