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 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 representing different properties.

For example, a user could use this node to create a new estate by providing detailed property information (like title, description, location, price) in JSON format, which the node then sends to OnOffice to register the estate.

Properties

Name Meaning
Data JSON object containing the details of the estate to create. This should be a valid JSON string representing the estate's attributes as expected by the OnOffice API.

Output

The node outputs a JSON object summarizing the result of the create operation. The structure includes:

  • success: Boolean indicating if the creation was successful (true).
  • resourceType: The resource involved, here always "estate".
  • operation: The operation performed, here "create".
  • data: The response data returned by the OnOffice API about the created estate.
  • message: A status message from the API confirming the creation.

Example output JSON:

{
  "success": true,
  "resourceType": "estate",
  "operation": "create",
  "data": {
    /* Created estate record details */
  },
  "message": "Record created successfully"
}

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to the OnOffice API using an API token and secret for authentication.
  • The node expects these credentials to be configured in n8n beforehand.
  • Network access to https://api.onoffice.de/api/v1 is necessary.
  • Uses HMAC signature generation for request authentication.

Troubleshooting

  • Invalid JSON in Data: If the "Data" property contains invalid JSON, the node throws 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 missing or incorrect, the node will fail with an authentication error. Verify that the API credentials are correctly set up.
  • OnOffice API Errors: Any errors returned by the OnOffice API will be surfaced with messages like "OnOffice API error: ". Check the API documentation or the message for details.
  • Network Issues: Network connectivity problems will cause errors such as "Network error: ". Confirm internet access and endpoint availability.
  • Unsupported Resource or Operation: If the node is misconfigured with unsupported resource-operation combinations, it will throw errors indicating the unsupported action.

Links and References

Discussion