OnOffice icon

OnOffice

Consume OnOffice API

Actions30

Overview

This node integrates with the OnOffice API to perform various operations on different resources related to real estate management. Specifically, for the Estate resource with the Get Many operation, it retrieves multiple estate records from the OnOffice system.

Common scenarios where this node is beneficial include:

  • Fetching a list of estates for display or further processing in workflows.
  • Synchronizing estate data between OnOffice and other systems.
  • Automating reporting or analytics based on estate information.

For example, a user might use this node to pull the latest 50 estate listings to update a website or trigger notifications when new estates are added.

Properties

Name Meaning
Include Debug Info Whether to include detailed debug information in the output (e.g., raw API response).

Output

The node outputs JSON data structured as follows:

  • When Include Debug Info is false (default), the output JSON contains:

    • success: Boolean indicating if the API call was successful.
    • resourceType: The resource queried, here "estate".
    • operation: The operation performed, here "getMany".
    • data: An array containing the retrieved estate records (empty array if none).

  • When Include Debug Info is true, the output JSON includes:

    • debug: true
    • rawResponse: The full raw response object returned by the OnOffice API.
    • requestSent: The exact request payload sent to the API.
    • url: The API endpoint URL used.

No binary data output is produced by this node.

Dependencies

  • Requires an API authentication token and secret credential for the OnOffice API.
  • Uses the OnOffice API endpoints:
    • For the Estate resource: https://api.onoffice.de/api/latest/api.php
    • For Relation resource with Get Many operation, a different stable API endpoint is used.
  • The node internally generates HMAC signatures for request authentication.
  • Requires n8n HTTP Request helper for making POST requests.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Network connectivity problems can prevent reaching the OnOffice API.
    • Exceeding API rate limits may result in errors or throttling.
    • Incorrect resource or operation parameters can lead to unexpected responses or errors.

  • Error messages:

    • "OnOffice API error: <message>" indicates an error response from the API, where <message> provides details.
    • If the node throws an error about unknown status or no response, verify API availability and credentials.

  • Resolution tips:

    • Ensure valid API token and secret are configured in the node credentials.
    • Check network access to api.onoffice.de.
    • Use the Include Debug Info property to get detailed request and response data for troubleshooting.
    • Confirm that the resource and operation parameters match supported values.

Links and References

Discussion