Wichtig: Dieser Service befindet sich derzeit in der Beta-Testphase. Wir freuen uns über dein Feedback an unser Kundenservice-Team. Während der Beta-Phase sind nur persönliche Zugriffstoken verfügbar. Service-Zugriffstoken folgen in einem zukünftigen Update.
Außerdem ist die API während der Beta-Phase in allen kostenpflichtigen Tarifen ohne Aufpreis verfügbar.
Was ist die Vivid Business API
Mit der Vivid Business API kannst du deine Kontoaktivitäten aus deinen eigenen Systemen abrufen. So überträgst du Transaktionen in deine Buchhaltungs-, Abstimmungs- oder Reporting-Tools, ohne Dateien manuell zu exportieren.
Aktuell kann die API nur lesen (persönliches Zugriffstoken). Du kannst die Transaktionen deiner Konten abrufen. Du kannst die API nicht nutzen, um Geld zu überweisen, Karten auszugeben oder zu verwalten, automatische Benachrichtigungen einzurichten oder Daten in eine Transaktion zurückzuschreiben. Wir planen, den Funktionsumfang künftig mit Service-Zugriffstoken zu erweitern.
Für die Nutzung brauchst du zwei Dinge:
Eine Liste der IP-Adressen, von denen aus die API erreichbar sein soll
Ein API-Token, das du in deinem Vivid Business Konto erstellst
So erstellst du ein Token
Bitte beachte: Nur Inhaber*innen und Admins können ein Token erstellen.
Melde dich im Web bei deinem Vivid Business Konto an.
Öffne in den Kontoeinstellungen den Bereich API.
Wähle Schlüssel erstellen.
Lies die Einwilligungserklärung und bestätige sie.
Kopiere das Token und bewahre es an einem sicheren Ort auf.
Derzeit sind alle Token 90 Tage gültig.
So widerrufst du ein Token
Öffne den Bereich API in deinem Konto und deaktiviere das Token, das du nicht mehr nutzen möchtest. Sobald ein Token deaktiviert ist, werden alle Anfragen damit abgelehnt.
Was passiert, wenn die Person, die das Token erstellt hat, aus dem Konto entfernt wird?
Während der Beta-Phase mit persönlichen Zugriffstoken gilt: Wird die Person, die das API-Token erstellt hat, aus dem Vivid Business Konto entfernt, wird das API-Token automatisch deaktiviert. Künftig kannst du mit Service-Zugriffstoken einen Schlüssel pro Unternehmenskonto einrichten.
Wie richte ich die API ein und wie nutze ich sie?
Weitere Informationen zur Nutzung der API findest du in unserer Dokumentation.
So schützt du deine Daten bei der Nutzung der Vivid Business API
Wenn du die API mit deinen Systemen oder einem Drittanbieter-Tool verbindest, werden deine Kontodaten auf deine Anweisung dorthin übermittelt. Diese Daten können personenbezogene Daten enthalten, etwa Namen von Teammitgliedern, Karteninhaber*innen oder Zahlungsgegenparteien. Sobald die Daten Vivid verlassen, liegen sie außerhalb unserer Kontrolle. Vivid prüft die Tools, die du verbindest, nicht und ist nicht dafür verantwortlich, wie diese deine Daten nutzen oder schützen. Für diese Verarbeitung bist du verantwortlich, auch im Sinne der DSGVO. Verbinde nur Tools, denen du vertraust, prüfe ihre Datenschutz- und Sicherheitspraktiken und teile nur die Daten, die sie benötigen.
Deine DSGVO-Rechte kannst du bei Vivid jederzeit für Verarbeitungen wahrnehmen, die Vivid verantwortet (siehe unseren Datenschutzhinweis). Für Daten, die bereits an ein Drittanbieter-Tool übermittelt wurden, wende dich direkt an dessen Anbieter.
Zum Schutz deines Kontos:
Token können nur nach einer Anmeldung mit Zwei-Faktor-Authentifizierung erstellt werden
Du legst fest, was jedes Token lesen darf – begrenzt auf die Transaktionen der letzten 90 Tage
Anfragen werden nur von deinen freigegebenen IP-Adressen angenommen
Token laufen automatisch ab und können jederzeit deaktiviert werden
Behandle dein Token wie ein Passwort, denn wer es hat, kann deine Daten lesen. Wenn du glaubst, dass es offengelegt wurde, deaktiviere es sofort und kontaktiere den Kundenservice.