OnOffice icon

OnOffice

Consume OnOffice API

Actions30

Overview

This node integrates with the OnOffice API to manage real estate-related data. It supports various operations such as creating, retrieving, updating, and deleting records across multiple resource types including estates, addresses, agent logs, relations, tasks, and IDs from relations.

For the Estate - Create operation specifically, the node allows users to create a new estate record in the OnOffice system by sending the appropriate data payload to the API.

Common scenarios:

  • Automating the addition of new estate listings into OnOffice from external sources.
  • Integrating OnOffice estate creation into workflows that gather property data.
  • Quickly adding estate records during lead or client onboarding processes.

Example use case:
A real estate agency uses this node to automatically create new estate entries in their OnOffice database whenever a new property is added via a web form or CRM system.

Properties

Name Meaning
Include Debug Info Whether to include detailed debug information (raw API response, request details) in the output. This helps troubleshoot API interactions.

Output

The node outputs JSON data structured as follows for the Estate Create operation:

  • When Include Debug Info is enabled:

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

    This output provides comprehensive details useful for debugging.

  • When Include Debug Info is disabled (default):

    {
  "success": true,
  "resourceType": "estate",
  "operation": "create",
  "data": []
}

    This indicates the operation succeeded; data may contain additional info depending on API response.

No binary data output is produced by this node.

Dependencies

  • Requires an API authentication token and secret credential for OnOffice API access.
  • Uses the OnOffice API endpoint at https://api.onoffice.de/api/latest/api.php (or a legacy endpoint for certain resources).
  • The node internally generates HMAC signatures for secure API requests.
  • 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.
    • Incorrect resource or operation parameters may result in API errors.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • "OnOffice API error: <message>" indicates the API returned an error status. Check the message for specifics.
    • If the node throws an error about missing required parameters (e.g., ID for update/delete), ensure all mandatory fields are set.
    • Enabling Include Debug Info can help diagnose issues by showing raw request and response data.

  • Resolution tips:

    • Verify API credentials are correct and have necessary permissions.
    • Confirm that the resource and operation selections match the intended action.
    • Use debug output to inspect the exact API request and response.
    • Ensure network access to the OnOffice API endpoint is not blocked.

Links and References

  • OnOffice API Documentation (official API docs)
  • n8n HTTP Request Node documentation for understanding underlying HTTP calls
  • General HMAC signature concepts for API security

If you need further details on other resources or operations, feel free to ask!

Discussion