Important : ce service est actuellement en phase de test bêta. Vos retours sont les bienvenus : n'hésitez pas à contacter notre service client. Pendant la phase bêta, seuls les jetons d'accès personnels sont disponibles. Les jetons d'accès de service seront proposés dans une prochaine mise à jour.
Toujours pendant la phase bêta, l'API est disponible avec toutes les offres payantes, sans frais supplémentaires.
Qu'est-ce que l'API Vivid Business
L'API Vivid Business vous permet de consulter l'activité de votre compte depuis vos propres systèmes. Vous pouvez ainsi importer vos opérations dans vos outils de comptabilité, de rapprochement ou de reporting sans exporter de fichiers manuellement.
Actuellement, l'API est en lecture seule (jeton d'accès personnel). Vous pouvez récupérer les opérations de vos comptes. Vous ne pouvez pas l'utiliser pour transférer de l'argent, émettre ou gérer des cartes, configurer des notifications automatiques ou modifier une opération. Nous prévoyons d'étendre ces fonctionnalités à l'avenir avec les jetons d'accès de service.
Pour l'utiliser, vous avez besoin de deux éléments :
La liste des adresses IP depuis lesquelles l'API doit être accessible
Un jeton API créé dans votre compte Vivid Business
Comment créer un jeton
Seuls les propriétaires et les administrateurs peuvent créer un jeton.
Connectez-vous à votre compte Vivid Business sur le web.
Accédez à la section API des paramètres de votre compte.
Sélectionnez Créer une clé.
Lisez et validez l'écran de consentement.
Copiez le jeton et conservez-le en lieu sûr.
Actuellement, tous les jetons sont valables 90 jours.
Comment révoquer un jeton
Accédez à la section API de votre compte et désactivez le jeton que vous ne souhaitez plus utiliser. Une fois le jeton désactivé, toutes les requêtes effectuées avec celui-ci sont refusées.
Que se passe-t-il si la personne qui a créé le jeton est retirée du compte ?
Pendant la phase bêta avec les jetons d'accès personnels, si la personne qui a créé le jeton API est retirée du compte Vivid Business, le jeton API est automatiquement désactivé. À l'avenir, les jetons d'accès de service vous permettront de configurer une clé par compte d'entreprise.
Comment configurer et utiliser l'API ?
Consultez notre documentation pour en savoir plus sur l'utilisation de l'API.
Protéger vos données lors de l'utilisation de l'API Vivid Business
Lorsque vous connectez l'API à vos systèmes ou à un outil tiers, les données de votre compte y sont transmises sur votre instruction. Ces données peuvent inclure des données personnelles, comme les noms des membres de votre équipe, des titulaires de carte ou des contreparties de paiement. Une fois sorties de Vivid, elles échappent à notre contrôle. Vivid ne vérifie pas les outils que vous connectez et n'est pas responsable de la manière dont ils utilisent ou protègent vos données. Ce traitement relève de votre responsabilité, y compris au titre du RGPD. Ne connectez que des outils de confiance, vérifiez leurs pratiques en matière de confidentialité et de sécurité, et ne partagez que les données dont ils ont besoin.
Vous pouvez toujours exercer vos droits RGPD auprès de Vivid pour les traitements dont Vivid est responsable (voir notre Politique de confidentialité). Pour les données déjà transmises à un outil tiers, contactez directement son fournisseur.
Pour protéger votre compte :
les jetons ne peuvent être créés qu'après une connexion avec authentification à deux facteurs
vous choisissez ce que chaque jeton peut lire, dans la limite des 90 derniers jours d'opérations
les requêtes ne sont acceptées que depuis vos adresses IP autorisées
les jetons expirent automatiquement et peuvent être désactivés à tout moment
Traitez votre jeton comme un mot de passe : toute personne qui le possède peut lire vos données. Si vous pensez qu'il a été exposé, désactivez-le immédiatement et contactez le service client.