OnOffice icon

OnOffice

Consume OnOffice API

Overview

This node integrates with the OnOffice API to perform various operations on different resources such as estates, addresses, agent logs, relations, tasks, and IDs from relations. Specifically, for the Agent Log resource with the Get Many operation, it retrieves multiple agent log records from the OnOffice system.

Common scenarios where this node is beneficial include:

  • Fetching a list of agent log entries for auditing or monitoring purposes.
  • Integrating OnOffice agent log data into workflows for reporting or further processing.
  • Automating retrieval of logs to trigger alerts or actions based on specific log entries.

Example use case: A real estate company wants to automatically pull recent agent activity logs daily to analyze agent performance or detect unusual activities.

Properties

Name Meaning
Include Debug Info Whether to include debug information in the output. If enabled, the node returns detailed raw API response and request data for troubleshooting.

Output

The node outputs JSON data structured as follows:

  • When Include Debug Info is disabled (default):

    {
      "success": true,
      "resourceType": "agentslog",
      "operation": "getMany",
      "data": []
    }
    
    • success: Indicates if the API call was successful.
    • resourceType: The resource queried, here "agentslog".
    • operation: The operation performed, here "getMany".
    • data: An array containing the retrieved agent log records (empty array shown as placeholder).
  • 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 includes the raw API response, the exact request sent, and the URL used, useful for debugging.

The node does not output binary data.

Dependencies

  • Requires an API token and secret credential for authenticating with the OnOffice API.
  • Uses the OnOffice API endpoint at https://api.onoffice.de/api/latest/api.php for most resources including Agent Log.
  • 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.
    • Network connectivity problems can prevent reaching the OnOffice API endpoint.
    • Request limits or incorrect parameters may result in API errors.
  • Error messages:

    • "OnOffice API error: <message>" indicates the API returned an error status. Check the message for details.
    • If the node throws an error about missing required parameters (e.g., ID when needed), verify input properties.
    • Enabling Include Debug Info helps diagnose issues by showing raw request and response data.
  • Resolution tips:

    • Ensure valid API token and secret are configured in the node credentials.
    • Verify network access to https://api.onoffice.de.
    • Use debug info to inspect request payloads and API responses.
    • Handle errors gracefully by enabling "Continue On Fail" if partial data retrieval is acceptable.

Links and References

  • OnOffice API Documentation (official API docs for reference)
  • n8n HTTP Request Node documentation for understanding HTTP calls within n8n workflows.

Discussion