OnOffice icon

OnOffice

Consume OnOffice API

Actions30

Overview

This node integrates with the OnOffice API to perform various operations on different resources such as estates, addresses, relations, tasks, and agent logs. Specifically, for the Estate resource with the Get operation, it retrieves a single estate record by its ID from the OnOffice system.

Common scenarios where this node is useful include:

  • Fetching detailed information about a specific real estate property by its unique identifier.
  • Integrating OnOffice estate data into workflows for reporting, notifications, or further processing.
  • Automating retrieval of estate details to synchronize with other systems or databases.

Example: A user wants to get the details of an estate with ID "12345" to display in a dashboard or trigger follow-up actions based on the estate's attributes.

Properties

Name Meaning
ID The unique identifier of the estate record to retrieve. This is required for the Get operation.
Include Debug Info Boolean flag to include detailed debug information in the output, such as raw API response and request data. Useful for troubleshooting.

Output

The node outputs JSON data structured as follows:

  • When Include Debug Info is false (default):

    {
  "success": true,
  "resourceType": "estate",
  "operation": "get",
  "data": []
}
    • success: Indicates if the API call was successful.
    • resourceType: The resource involved ("estate").
    • operation: The operation performed ("get").
    • data: An array containing the retrieved estate record(s). The exact structure depends on the OnOffice API response.

  • When Include Debug Info is true:

    {
  "debug": true,
  "rawResponse": { /* full API response object */ },
  "requestSent": { /* full request payload sent to API */ },
  "url": "https://api.onoffice.de/api/latest/api.php"
}

    This includes the raw API response, the request body sent, and the URL used, which helps in debugging issues.

The node does not output binary data.

Dependencies

  • Requires valid credentials for the OnOffice API, specifically an API token and secret.
  • Uses the OnOffice API endpoint at https://api.onoffice.de/api/latest/api.php (or a legacy endpoint for certain relation queries).
  • The node internally generates HMAC signatures for authentication using the provided API credentials.
  • No additional external dependencies beyond the OnOffice API and n8n's HTTP request helper.

Troubleshooting

  • Common Issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Providing an incorrect or non-existent estate ID will result in an API error indicating the record was not found.
    • Network connectivity issues can prevent reaching the OnOffice API endpoint.

  • Error Messages:

    • "OnOffice API error: <message>" indicates the API returned an error status. The message usually describes the problem (e.g., invalid ID, permission denied).
    • If the node throws an error but Include Debug Info is enabled, inspect the raw response and request payload to diagnose issues.

  • Resolutions:

    • Verify that the API token and secret are correctly configured in the node credentials.
    • Confirm the estate ID exists and is correctly formatted.
    • Enable debug info to get more insight into the API communication.
    • Check network access and firewall settings to ensure the node can reach the OnOffice API.

Links and References

Discussion