REST API nutzen, wenn die Make Integration nicht infrage kommt

Wenn Sie Daten aus dem NETZWERKZEUG mit einer anderen Software austauschen möchten, ist unsere Make Integration häufig der einfachste Weg.

Informationen zur Einrichtung von Make finden Sie hier:

https://helpcenter.netzwerkzeug.com/portal/de/kb/articles/ersteinrichtung-make

Wenn Make für Ihren Anwendungsfall nicht infrage kommt, können Sie alternativ unsere offene REST API nutzen.

Was ist über die REST API möglich?

Über die Schnittstelle können externe Systeme auf definierte Bereiche des NETZWERKZEUGs zugreifen.

Dazu gehören unter anderem:

• Kontakte
• Digitale Ordner
• Dokumente
• Verlaufsdaten zu Kontakten, Ordnern und Dokumenten

Für die technische Umsetzung stellen wir eine ausführliche API Dokumentation sowie eine Swagger UI zur Verfügung.

Welche Voraussetzung gibt es?

Für die Nutzung der REST API ist ein Schnittstellenvertrag mit der NETZWERKZEUG GmbH erforderlich.

Erst nach Unterzeichnung dieses Vertrags stellen wir den Zugang zur API und zu unserem Developer Portal bereit.

Warum ist ein Schnittstellenvertrag erforderlich?

Über eine API kann ein externes System direkt auf Daten und Funktionen des NETZWERKZEUGs zugreifen.

Deshalb muss eindeutig geregelt sein:

• wer die Schnittstelle nutzen darf
• wofür die Schnittstelle genutzt werden darf
• wie Zugangsdaten geschützt werden müssen
• welche Sicherheitsanforderungen gelten
• wie mit vertraulichen Informationen umzugehen ist
• welche datenschutzrechtlichen Pflichten bestehen

Der Schnittstellenvertrag schafft dafür einen verbindlichen Rahmen und regelt die Rechte und Pflichten beider Seiten.

Aus diesem Grund geben wir API Zugangsdaten und die vollständige Schnittstellendokumentation nicht ohne vorherigen Vertragsabschluss heraus.

Was passiert nach der Unterzeichnung?

Nach Abschluss des Schnittstellenvertrags erhalten Sie:

einen Zugang zu unserem Developer Portal
die ausführliche API Dokumentation
Zugang zur Swagger UI
eine Demo Instanz in unserer Testumgebung

In der Demo Instanz können Sie die Schnittstelle testen, bevor Sie diese mit Ihrem eigenen System verbinden.

Wie beantrage ich den API Zugang?

Wenn Sie unsere REST API nutzen möchten, füllen Sie bitte diese Formular aus:

https://zfrmz.eu/TsYIu6GWy0wsXp38QM6C

Anschließend erhalten Sie den Schnittstellenvertrag und alle weiteren Informationen zur Einrichtung.