OnOffice

Consume OnOffice API
Join our community

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data, specifically estates, addresses, and relations. For the Address resource with the Create operation, it allows users to create a new address record in the OnOffice system by providing the necessary address data in JSON format.

Common scenarios where this node is beneficial include:

  • Automating the addition of new contact addresses into a real estate management system.
  • Integrating form submissions or CRM data to automatically create address entries.
  • Synchronizing external address data sources with OnOffice.

Example: A user collects contact information via a web form and uses this node to create corresponding address records in OnOffice without manual entry.

Properties

Name Meaning
Data JSON object containing the details of the address to create. This should include all required fields as per OnOffice API specifications for an address record.

Output

The node outputs a JSON object with the following structure:

  • success: Boolean indicating if the creation was successful.
  • resourceType: The resource type, here always "address".
  • operation: The operation performed, here "create".
  • data: The response data from OnOffice API about the created address.
  • message: A status message returned by the API.

Example output JSON:

{
  "success": true,
  "resourceType": "address",
  "operation": "create",
  "data": {
    /* Created address record details */
  },
  "message": "Record created successfully"
}

The node does not output binary data.

Dependencies

  • Requires an API token and secret for authenticating with the OnOffice API.
  • Needs the OnOffice API credentials configured in n8n (an API key credential and secret).
  • Uses the OnOffice REST API endpoint at https://api.onoffice.de/api/latest/api.php.

Troubleshooting

  • Invalid JSON in Data property: If the JSON provided in the Data field is malformed, the node will throw an error stating "Data must be a valid JSON". Ensure the JSON syntax is correct.
  • API authentication errors: If the API token or secret are incorrect or missing, the node will fail to authenticate. Verify that the credentials are correctly set up.
  • OnOffice API errors: Errors returned by the API will be shown with their message, e.g., validation errors or missing required fields. Review the API documentation for required fields and constraints.
  • Network issues: Network connectivity problems will result in a "Network error" message. Check your internet connection and firewall settings.

Links and References

Discussion