REST-/API-Schnittstelle
Über die URL SERVERADRESSE/api/v1/docs erreichen Sie die integrierte Swagger-Oberfläche der venabo REST-API. Dort erhalten Sie einen Überblick über alle in Ihrer venabo-Version verfügbaren API-Endpunkte.
API-Token
Vor der Nutzung der API muss in der Benutzerverwaltung ein Benutzer mit den benötigten Rechten für den API-Zugriff angelegt werden. Die Authentifizierung an der REST-API erfolgt anschließend über den generierten Token.
Um einen Benutzer für den API-Zugriff anzulegen, klicken Sie unter „Verwaltung“ auf „Benutzer“. In der Benutzerverwaltung können Sie über „Neuer Benutzer“ einen neuen Eintrag anlegen und diesem über Rollen oder Einzelrechte die benötigten Berechtigungen zuweisen. Stellen Sie den Typ des Benutzers auf „API“.
Über die REST-API können Sie Daten aus venabo auslesen, erstellen und ändern. Ein REST-Beispiel mit Beispielaufrufen steht unter https://doku.venabo.de/download/ zur Verfügung. In der dortigen Übersicht finden Sie zudem generierte Beispiel-JSON-Strukturen, die Ihnen den Aufbau eigener Requests und den Abruf Ihrer Daten erleichtern.
Eine erweiterte REST-Api Schnittstelle wird ergänzt um folgende Punkte:
- Zulage
- Mitarbeiter- und Tätigkeitszuweisungen für Aufträge
- Filter für Adressen
- Einsatzplanung
Die API-Beschreibung zu allen Erweiterungen der venabo REST API ist verständlich und benutzbar über Swagger einzusehen.