REST API
v1
44 Events
22 Endpoints

API Documentation

Integrieren Sie dVersum in Ihre Workflows mit unserer REST-API und Webhooks.

Base URL
https://dversum.com/api/v1

Übersicht

Die dVersum API ermöglicht es Ihnen, Ihre Buchhaltungs- und Projektmanagement-Workflows zu automatisieren. Sie können sowohl Daten empfangen (ausgehende Webhooks) als auch Daten senden (eingehende Webhooks).

Für Schritt-für-Schritt-Anleitungen zur Einrichtung von Webhooks mit n8n, Zapier und anderen Tools besuchen Sie unser Hilfe-Center.

Ausgehende Webhooks

Erhalten Sie Benachrichtigungen, wenn Ereignisse in dVersum auftreten - perfekt für Zapier, n8n oder eigene Systeme.

Eingehende Webhooks

Erstellen Sie Aufgaben, Kunden und mehr direkt aus Ihren anderen Tools heraus.

Authentifizierung

Alle API-Anfragen müssen mit einem API-Key authentifiziert werden. Sie erhalten einen API-Key, wenn Sie einen eingehenden Webhook erstellen.

API-Key erstellen

  1. 1

    Gehen Sie zu EinstellungenWebhooks

  2. 2

    Klicken Sie auf Eingehende Webhooks

  3. 3

    Erstellen Sie einen neuen Webhook und wählen Sie die benötigten Berechtigungen

  4. 4

    Kopieren Sie den angezeigten API-Key

    Der Key wird nur einmal angezeigt!

Authorization Header
Authorization: Bearer ik_live_your_api_key_here
cURL Beispiel
curl -X POST https://dversum.com/api/v1/webhooks/incoming/tasks \
  -H "Authorization: Bearer ik_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"project_id": "proj_123", "title": "New Task"}'

Ausgehende Webhooks

Ausgehende Webhooks senden automatisch HTTP-Anfragen an Ihre URL, wenn bestimmte Ereignisse in dVersum auftreten.

Verfügbare Ereignisse

44 Events
Rechnungen
invoice.createdNeue Rechnung erstellt
invoice.updatedRechnung aktualisiert
invoice.sentRechnung versendet
invoice.paidRechnung bezahlt
invoice.partially_paidTeilzahlung erhalten
invoice.overdueRechnung überfällig
invoice.deletedRechnung gelöscht
Angebote
quote.createdNeues Angebot erstellt
quote.updatedAngebot aktualisiert
quote.sentAngebot versendet
quote.signedAngebot unterzeichnet
quote.rejectedAngebot abgelehnt
quote.expiredAngebot abgelaufen
quote.convertedIn Rechnung umgewandelt
quote.deletedAngebot gelöscht
Kunden
client.createdNeuer Kunde angelegt
client.updatedKunde aktualisiert
client.deletedKunde gelöscht
Mahnwesen
reminder.sentMahnung versendet
Projekte
project.createdNeues Projekt erstellt
project.updatedProjekt aktualisiert
project.archivedProjekt archiviert
project.deletedProjekt gelöscht
Aufgaben
task.createdNeue Aufgabe erstellt
task.updatedAufgabe aktualisiert
task.completedAufgabe abgeschlossen
task.assignedAufgabe zugewiesen
task.movedAufgabe verschoben
task.deletedAufgabe gelöscht
subtask.createdUnteraufgabe erstellt
subtask.completedUnteraufgabe erledigt
subtask.deletedUnteraufgabe gelöscht
comment.createdKommentar erstellt
Zeiterfassung
time_entry.createdZeiteintrag erstellt
time_entry.startedTimer gestartet
time_entry.stoppedTimer gestoppt
time_entry.updatedZeiteintrag aktualisiert
time_entry.deletedZeiteintrag gelöscht
Seiten
page.createdNeue Seite erstellt
page.updatedSeite aktualisiert
page.deletedSeite gelöscht
Abwesenheiten
absence.createdAbwesenheit eingetragen
absence.updatedAbwesenheit aktualisiert
absence.deletedAbwesenheit gelöscht
Beispiel-Payload
{
  "event": "invoice.created",
  "timestamp": "2024-01-15T10:30:00Z",
  "data": {
    "id": "inv_abc123",
    "invoice_number": "RE-2024-0001",
    "client_id": "cli_xyz789",
    "total": 1190.00,
    "currency": "EUR",
    "status": "draft"
  }
}

Signatur-Verifizierung

Jeder Webhook enthält eine Signatur im Header zur Verifizierung:

X-Webhook-Signature: sha256=abc123...

Eingehende Webhooks

Eingehende Webhooks ermöglichen es externen Systemen, Daten an dVersum zu senden und Aktionen auszuführen.

Verfügbare Berechtigungen

tasks:readtasks:createtasks:updatetasks:deleteprojects:readprojects:createprojects:updateprojects:deleteclients:readclients:createclients:updateclients:deletetime_entries:readtime_entries:createtime_entries:updatetime_entries:deleteinvoices:readinvoices:createinvoices:updatequotes:readquotes:createquotes:update

Sie können optional eine IP-Whitelist konfigurieren, um den Zugriff auf bestimmte IP-Adressen zu beschränken.

API Endpoints

Vollständige Referenz aller verfügbaren API-Endpunkte für eingehende Webhooks.

Fehlerbehandlung

Die API verwendet Standard-HTTP-Statuscodes. Im Fehlerfall enthält die Antwort zusätzliche Informationen.

CodeNameBeschreibung
400Bad RequestUngültige Anfrage oder fehlende Pflichtfelder
401UnauthorizedFehlender oder ungültiger API-Key
403ForbiddenKeine Berechtigung für diese Aktion
404Not FoundRessource nicht gefunden
422Unprocessable EntityValidierungsfehler
429Too Many RequestsRate Limit erreicht
500Internal Server ErrorServerfehler
Fehler-Response Beispiel
{
  "error": {
    "code": "validation_error",
    "message": "The project_id field is required",
    "field": "project_id"
  }
}

Rate Limits

Um die Stabilität der API zu gewährleisten, gelten folgende Limits:

TypLimit
Ausgehende Webhooks1,000/hour
Eingehende Webhooks100/minute
API-Aufrufe gesamt10,000/day

Rate Limit Headers

Jede Response enthält Headers mit Informationen zum aktuellen Limit-Status:

X-RateLimit-Limit:Maximale Anfragen
X-RateLimit-Remaining:Verbleibende Anfragen
X-RateLimit-Reset:Reset-Zeitpunkt (Unix Timestamp)

Bei Überschreitung

Sie erhalten den Status-Code 429 (Too Many Requests). Warten Sie, bis das Limit zurückgesetzt wird.

Bereit für die Integration?

Erstellen Sie jetzt Ihren ersten API-Key und verbinden Sie dVersum mit Ihren Tools.