URL-Aufrufe

Mit URL-Aufrufen steuern Sie gezielt einzelne Funktionen in venabo direkt an – ohne manuell durch die Oberfläche zu navigieren. Dieser Artikel zeigt Ihnen alle verfügbaren Aufrufe und deren Parameter.

💡 Hinweis: Ersetzen Sie SERVERADRESSE in allen URLs durch die Adresse Ihres venabo-Servers, z. B. https://test.venabo.de oder https://meinserver.venabo.cloud.

Zeiterfassung

Buchung durchführen

Mit folgendem URL-Aufruf übermitteln Sie eine Stempelung direkt an venabo:

SERVERADRESSE/stamps/new?df_api=1&df_record_state=1&df_table=stamp&df_col_key=470a8ba5-0d29-46&df_col_employee=106306818&df_col_type=1&df_col_date=2024-11-12T07%3A44%3A21

Die URL unterstützt folgende Parameter:

Parameter Beschreibung Beispiel
df_col_key Der API-Key des Stempelgeräts (z. B. Datafox-Terminal). Dient zur Authentifizierung der Quelle. 470a8ba5-0d29-46
df_col_employee Die RFID-Nummer oder Mitarbeiterkennung des Mitarbeiters, der stempelt. 106306818
df_col_type Die Art der Stempelung:
1 = Kommen
2 = Gehen
3 = Pause
1
df_col_date Der Zeitpunkt der Stempelung im ISO-Format YYYY-MM-DDThh:mm:ss. Sonderzeichen müssen URL-kodiert sein (z. B. :%3A). 2024-11-12T07%3A44%3A21

Kontaktmanager aufrufen

Sie können einen Kontakt direkt über seine Kunden- oder Lieferantennummer öffnen:

Variante URL
Kundennummer verwenden SERVERADRESSE/addresses/open?customerReference=KUNDENNUMMER
Lieferantennummer verwenden SERVERADRESSE/addresses/open?supplierReference=LIEFERANTENNUMMER

Timer starten

Starten Sie einen Timer direkt per URL – entweder über eine Kundennummer oder eine Rufnummer:

Variante URL
Mit Kundennummer SERVERADRESSE/timers/start?customer=KUNDENNUMMER
Mit Rufnummer SERVERADRESSE/timers/start?phone_number=0049123456789

Vorgang erstellen

Legen Sie einen neuen Vorgang direkt per URL an und übergeben Sie dabei Kunden-, Lieferanten- und Ansprechpartnerinformationen:

SERVERADRESSE/processes/add?customerReference=KUNDENNUMMER&supplierReference=LIEFERANTENNUMMER&contactPerson=Max%20Mustermann

Ticket erstellen

Erstellen Sie ein neues Ticket und weisen Sie es direkt einer Kundennummer zu:

SERVERADRESSE/tickets/add?customerReference=KUNDENNUMMER

Reports aufrufen

Rufen Sie einen Report direkt per URL auf und übergeben Sie Filterwerte als Parameter:

SERVERADRESSE/reports?reportName=Urlaubstage&vVon=2025-01-01&vBis=2025-01-10&vDepartment=3&preview=1

Die URL unterstützt folgende Parameter:

Parameter Beschreibung
reportName Name des gewünschten Reports (exakt wie in venabo hinterlegt)
preview 0 = Report direkt herunterladen  |  1 = Vorschau im Browser anzeigen
Weitere Filterparameter Über die Report-Einstellungen konfigurierbar (siehe Screenshot unten)

⚠️ Hinweis: Zusätzliche Filterparameter müssen exakt den Namen der Filtereinstellungen im Report verwenden – Groß- und Kleinschreibung beachten!

Praxisbeispiel

Szenario: Ein Mitarbeiter stempelt um 07:44 Uhr am Datafox-Terminal. Das Terminal sendet automatisch einen URL-Aufruf an venabo, um die Kommen-Buchung zu registrieren.

Parameter Wert im Beispiel Bedeutung
df_col_key 470a8ba5-0d29-46 API-Key des Terminals
df_col_employee 106306818 RFID-Nummer des Mitarbeiters
df_col_type 1 Kommen-Buchung
df_col_date 2024-11-12T07%3A44%3A21 12. November 2024, 07:44:21 Uhr
Ergebnis venabo registriert eine Kommen-Buchung für den Mitarbeiter um 07:44 Uhr.

Häufige Fragen

Was passiert, wenn der API-Key ungültig ist?

venabo lehnt die Buchung ab und gibt einen Fehler zurück. Prüfen Sie den API-Key in den Einstellungen des jeweiligen Stempelgeräts und stellen Sie sicher, dass er exakt übereinstimmt.

Kann ich mehrere Filterparameter in einem Report-Aufruf kombinieren?

Ja. Hängen Sie jeden weiteren Parameter mit einem & an die URL an. Achten Sie darauf, dass die Parameternamen exakt den Bezeichnungen in den Report-Einstellungen entsprechen.

Warum wird der Kontakt beim Aufruf des Kontaktmanagers nicht gefunden?

Prüfen Sie, ob die übergebene Kunden- oder Lieferantennummer in venabo korrekt hinterlegt ist. Die Nummer muss exakt mit dem gespeicherten Wert übereinstimmen – Leerzeichen oder führende Nullen können zu keinem Treffer führen.

Kann ich URL-Aufrufe auch automatisieren?

Ja. URL-Aufrufe lassen sich in externe Systeme, Skripte oder Hardware-Terminals integrieren. Stempelgeräte wie das Datafox-Terminal nutzen dieses Verfahren, um Buchungen automatisch an venabo zu übermitteln.

Übersicht aller URL-Aufrufe

Funktion URL-Muster
Stempelung buchen …/stamps/new?df_api=1&df_col_key=…&df_col_employee=…&df_col_type=…&df_col_date=…
Kontakt per Kundennummer öffnen …/addresses/open?customerReference=…
Kontakt per Lieferantennummer öffnen …/addresses/open?supplierReference=…
Timer per Kundennummer starten …/timers/start?customer=…
Timer per Rufnummer starten …/timers/start?phone_number=…
Vorgang erstellen …/processes/add?customerReference=…&supplierReference=…&contactPerson=…
Ticket erstellen …/tickets/add?customerReference=…
Report aufrufen …/reports?reportName=…&preview=0|1&[Filterparameter]