Ihr System über die API mit Venzeo verbinden

Nur Administratoren können die API-Dokumentation mit dem API-Schlüssel öffnen.

Die Venzeo™-API verbindet Ihr eigenes System, wie etwa ein ERP, GIS oder Bestandsverzeichnis, mit Venzeo. Ihr System kann Meldungen herunterladen und Orte des Interesses, Projekte sowie Inventar aktuell halten. Die API funktioniert für jede aktive Organisation. Ein Entwickler richtet die Anbindung ein. Auf dieser Seite erfahren Sie, was Sie dafür übergeben müssen.

Beispiel: Ein Entsorgungsunternehmen kopiert jede Nacht neue Meldungen in sein ERP und aktualisiert seine Behälterliste aus seinem Inventar-Verzeichnis.

Den API-Schlüssel abrufen

1. Öffnen Sie das Hauptmenü. Falls es eingeklappt ist, klicken Sie auf Menü anzeigen.
2. Klappen Sie API für Entwickler auf. Bis Ihre Organisation die API verwendet hat, befindet sich dieser Bereich am Ende des Menüs mit der Kennzeichnung Inaktiv.
3. Wählen Sie API-Dokumentation anzeigen. Die Dokumentation öffnet sich in einem neuen Tab, wobei der API-Schlüssel Ihrer Organisation bereits hinterlegt ist.
4. Führen Sie auf dieser Seite die Anfrage zum Exportieren von Meldungen aus.
5. Kopieren Sie im curl-Beispiel dieser Anfrage den Text nach Authorization: Bearer. Dies ist Ihr API-Schlüssel.

Warnung: Behandeln Sie den API-Schlüssel wie ein Passwort. Damit kann jeder Ihre Meldungen lesen sowie Ihre Orte des Interesses, Projekte und Ihr Inventar erstellen, ändern und deaktivieren. Falls der Schlüssel offengelegt wird, schreiben Sie sofort an support@venzeo.com.

Was Sie Ihren Entwicklern senden sollten

• Die öffentliche API-Dokumentation: https://api-external-eu.venzeo.com/docs/external/d41d8cd98f00b204e9800998ecf8427e/. Sie lässt sich ohne Anmeldung öffnen. Der Leitfaden am Anfang beschreibt die typischen Arbeitsabläufe und Fehlercodes.
• Den API-Schlüssel über einen separaten, sicheren Kanal.
• Welche Daten die Anbindung lesen oder ändern darf, zum Beispiel nur Meldungen oder auch Orte des Interesses.

Punkte, die Entwickler oft übersehen

• Zeitangaben sind Unix-Zeitstempel in Millisekunden.
• Felder ohne Wert werden in der Antwort weggelassen und nicht als null übermittelt.
• Wenn POST mit 409 antwortet, existiert der Datensatz bereits; senden Sie stattdessen PUT.

Um Meldungen ohne Programmierung zu exportieren, siehe Gefilterte Meldungen exportieren.