OnOffice

Overview

This node integrates with the OnOffice API to perform various operations on different resources such as estates, addresses, relations, tasks, and specifically "IDs From Relation". For the "Get Many" operation on the "IDs From Relation" resource, it retrieves multiple records related to IDs associated with relations.

Common scenarios include:

• Fetching a list of relation IDs for further processing or filtering.
• Integrating OnOffice data into workflows that require bulk retrieval of relation-related identifiers.
• Automating data synchronization between OnOffice and other systems by pulling multiple relation IDs at once.

Example use case: A real estate agency wants to retrieve all relation IDs linked to certain contacts to update their CRM system in bulk.

Properties

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 (e.g., "idsfromrelation").
  • operation: the operation performed ("getMany").
  • data: an array containing the retrieved records (relation IDs in this context).

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

  • debug: set to true.
  • rawResponse: the full raw response from the OnOffice API.
  • requestSent: the exact request payload sent to the API.
  • url: the API endpoint URL used.

If the API call fails and the node is configured to continue on failure, the output will contain:

• success: false
• error: error message describing the failure
• resourceType and operation for context.

The node does not output binary data.

Dependencies

• Requires an API key credential for authenticating with the OnOffice API, including an API token and secret.
• Uses the OnOffice API endpoints:
  • Stable API: https://api.onoffice.de/api/stable/api.php (used only for "relation" resource with "getMany" operation)
  • Latest API: https://api.onoffice.de/api/latest/api.php (used for other cases)
• The node internally generates HMAC signatures for secure API requests using the provided 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.
  • Incorrect resource or operation parameters may lead to unexpected API errors.
  • Network connectivity problems can prevent reaching the OnOffice API endpoint.
  • Rate limiting or API quota exceeded errors from OnOffice.

• Error messages:

  • "OnOffice API error: <message>" indicates an error returned by the API. Check the message for specifics like invalid parameters or authentication issues.
  • "Unknown error" suggests the API response did not include a clear error message; verify network and credentials.

• Resolutions:

  • Ensure valid API token and secret are configured in the node credentials.
  • Verify the selected resource and operation match the intended API usage.
  • Enable "Include Debug Info" to get detailed request and response data for troubleshooting.
  • Check network access and firewall settings to allow outbound HTTPS requests to OnOffice API.
  • Consult OnOffice API documentation for rate limits and error codes.

Links and References

• OnOffice API Documentation (official API docs for understanding available resources and operations)
• n8n HTTP Request Node Documentation (for understanding how HTTP requests are made within n8n)