Zum Hauptinhalt springen

API (Schnittstelle)

Allgemein​

Über die Schnittstelle (API) können externe Anwendungen mit der IK-Report Gutachter App kommunizieren und Prozesse automatisiert werden.

Folgende Funktionen stehen zur Verfügung:

  • Anlegen von Projekten inklusive der Kundendaten
  • Upload von Lageplänen
  • Herunterladen generierter Dokumente
  • Herunterladen einzelner Bilder und Lagepläne
  • Auslesen sämtlicher Projektdaten (vergleichbar mit dem Inhalt der Excel-Exportdatei)

Die API ist als zusätzliches Modul im Rahmen der IK-Connect-Lizenz erhältlich.

Authentifizierung​

Für den Zugriff auf die API benötigen Sie einen technischen Benutzer. Teilen Sie uns hierfür bitte eine separate E-Mail-Adresse mit, beispielsweise api-user@ihrunternehmen.de. Eine bestehende E-Mail-Adresse, die bereits mit einer Lizenz verbunden ist, ist nicht zulässig. Für technische Benutzer stehen folgende Rollen zur Verfügung:

  • Lesen
  • Schreiben
  • Basis (Lesen+Schreiben+Konfiguration setzen)

Standardmäßig vergeben wir die Rolle Basis. Falls aufgrund Ihrer Sicherheitsanforderungen ausschließlich ein Lesezugriff gewünscht ist, teilen Sie uns dies bitte bei der Einrichtung mit.

Nach der Einrichtung des technischen Benutzers können Sie das Passwort selbst festlegen. Rufen Sie hierzu die Anmeldeseite unter https://app.ik-report.de auf und verwenden Sie die Funktion „Passwort vergessen“.

info

Aus Sicherheitsgründen empfehlen wir, das Passwort des technischen Benutzers regelmäßig zu ändern.

Webhooks​

Mit Webhooks können nach der Dokumentengenerierung automatisch Folgeprozesse ausgelöst werden. Typische Anwendungsfälle sind:

  • Automatisches Speichern der generierten Dokumente auf einem eigenen Dateiserver
  • Weiterverarbeitung der Dokumente in Drittsystemen
  • Übergabe von Projektdaten an andere Anwendungen oder Workflows

Schnittstellen-Dokumentation​

Die vollständige technische Dokumentation der API finden Sie in der Schnittstellendokumentation. Dort sind sämtliche Endpunkte, Parameter und Antwortformate beschrieben.

Prozess-Automatisierung​

Die API lässt sich mit verschiedenen Automatisierungsplattformen kombinieren.

So können beispielsweise:

  • beim Anlegen eines Projekts automatisch Kundendaten aus einem CRM-System übernommen werden,
  • generierte Dokumente in Cloud-Speichern abgelegt werden oder
  • Projektdaten durch KI-Anwendungen weiterverarbeitet werden.

Nachfolgend stellen wir zwei häufig verwendete Lösungen vor.

zapier​

Die IK-Report-App verfügt über eine zapier-Integration.

Zapier ist eine Cloud-Plattform zur Automatisierung von Arbeitsabläufen zwischen tausenden Apps – ganz ohne Programmierung. Es eignet sich besonders für einfache bis mittelkomplexe Automatisierungen und bietet eine sehr benutzerfreundliche Oberfläche mit einer großen Auswahl von fertigen Integrationen an.

n8n​

n8n ist eine Workflow-Automatisierungsplattform, die sich besonders für komplexe, flexible und individuelle Automatisierungen eignet. Im Gegensatz zu Zapier unterstützt sie umfangreiche Logik, JavaScript-Code, KI-Workflows und kann sowohl als Cloud-Dienst als auch selbst gehostet betrieben werden.

Für den Einstieg stellen wir ein Beispiel-Template bereit:

info

Wir unterstützen Sie gerne bei Fragen zur IK-Report API und deren Nutzung.

Bitte beachten Sie, dass wir keinen Support für die Einrichtung oder Konfiguration von Drittanbieter-Software wie Zapier oder n8n anbieten können. Wenden Sie sich hierfür bitte direkt an den jeweiligen Softwareanbieter.