Belangrijk: deze service bevindt zich momenteel in de bètatestfase en we horen graag je feedback via ons klantenserviceteam. Tijdens de bètafase zijn alleen persoonlijke toegangstokens beschikbaar. Service-toegangstokens volgen in een toekomstige update.
Ook is de API tijdens de bètafase zonder extra kosten beschikbaar in alle betaalde abonnementen.
Wat is de Vivid Business API
Met de Vivid Business API lees je je accountactiviteit uit vanuit je eigen systemen. Zo haal je transacties binnen in je boekhoud-, afstemmings- of rapportagetools zonder handmatig bestanden te exporteren.
Op dit moment is de API alleen-lezen (persoonlijk toegangstoken). Je kunt transacties op je rekeningen ophalen. Je kunt de API niet gebruiken om geld over te maken, kaarten uit te geven of te beheren, automatische meldingen in te stellen of iets terug te schrijven naar een transactie. We willen de mogelijkheden in de toekomst uitbreiden met service-toegangstokens.
Om de API te gebruiken heb je twee dingen nodig:
De lijst met IP-adressen van waaruit de API toegankelijk moet zijn
Een API-token dat je aanmaakt in je Vivid Business-account
Een token aanmaken
Let op: alleen eigenaren en beheerders kunnen het token aanmaken.
Log in op je Vivid Business-account op het web.
Ga naar het onderdeel API in je accountinstellingen.
Selecteer Sleutel aanmaken.
Lees en bevestig het toestemmingsscherm.
Kopieer het token en bewaar het op een veilige plek.
Momenteel zijn alle tokens 90 dagen geldig.
Een token intrekken
Ga naar het onderdeel API van je account en deactiveer het token dat je niet meer wilt gebruiken. Zodra een token is gedeactiveerd, worden alle verzoeken met dat token geweigerd.
Wat gebeurt er als de persoon die het token heeft aangemaakt uit het account wordt verwijderd?
Tijdens de bètafase met persoonlijke toegangstokens geldt: als de persoon die het API-token heeft aangemaakt uit het Vivid Business-account wordt verwijderd, wordt het API-token automatisch gedeactiveerd. In de toekomst kun je met service-toegangstokens één sleutel per bedrijfsaccount instellen.
Hoe stel ik de API in en hoe gebruik ik deze?
Raadpleeg onze documentatie voor meer informatie over het gebruik van de API.
Je gegevens veilig houden bij gebruik van de Vivid Business API
Wanneer je de API koppelt aan je systemen of een tool van derden, worden je accountgegevens op jouw instructie daarheen verzonden. Deze gegevens kunnen persoonsgegevens bevatten, zoals namen van teamleden, kaarthouders of tegenpartijen van betalingen. Zodra de gegevens Vivid verlaten, vallen ze buiten onze controle. Vivid controleert de tools die je koppelt niet en is niet verantwoordelijk voor hoe deze je gegevens gebruiken of beschermen. Die verwerking is jouw verantwoordelijkheid, ook onder de AVG. Koppel alleen tools die je vertrouwt, bekijk hun privacy- en beveiligingspraktijken en deel alleen de gegevens die ze nodig hebben.
Je kunt je AVG-rechten altijd bij Vivid uitoefenen voor verwerkingen waarvoor Vivid verantwoordelijk is (zie onze Privacyverklaring). Voor gegevens die al naar een tool van derden zijn verzonden, neem je rechtstreeks contact op met de aanbieder daarvan.
Om je account te beschermen:
tokens kunnen alleen worden aangemaakt na inloggen met tweestapsverificatie
jij kiest wat elk token mag lezen, beperkt tot de transacties van de afgelopen 90 dagen
verzoeken worden alleen geaccepteerd vanaf je toegestane IP-adressen
tokens verlopen automatisch en kunnen op elk moment worden gedeactiveerd
Behandel je token als een wachtwoord, want iedereen die het heeft, kan je gegevens lezen. Als je denkt dat het is uitgelekt, deactiveer het dan direct en neem contact op met de klantenservice.