Cette documentation explique de manière détaillée et accessible comment fonctionne l'API Vidata, pour permettre à tous, du Responsable Marketing au Développeur, de comprendre et d'exploiter au mieux notre outil



Sommaire



Synthèse

Imaginez que vous voulez commander une pizza. Vous pourriez aller à la pizzeria, rencontrer le cuisinier, lui dire vos préférences, attendre qu'il la prépare, puis la ramener chez vous. Mais ça serait compliqué et long, n'est-ce pas ? Au lieu de ça, vous appelez simplement le restaurant, passez votre commande, et une fois prête, la pizza est livrée chez vous. Dans cette analogie, l'API est le téléphone et le numéro de téléphone que vous utilisez pour passer votre commande. L'API (Application Programming Interface) est un outil qui permet à deux logiciels de communiquer entre eux de manière simple et structurée.

Pour Vidata, cela signifie que vous pouvez nous "appeler" (ou plutôt, "envoyer un message") avec les informations que vous voulez utiliser pour personnaliser une vidéo, et nous vous renvoyons l'URL de la vidéo personnalisée.

https://media.giphy.com/media/iJa6kOfJ3qN7a/giphy.gif

Plongée technique dans l'API Vidata 🏊‍♀️🕹️


Les Routes API 🚦🗺️


Pensez aux routes API comme à des chemins spécifiques que vous pouvez suivre pour accéder à différentes fonctions de notre service. Par exemple, une route pourrait être "commander une pizza aux olives". Dans notre API, nous avons un certain nombre de ces routes qui permettent d'accomplir différentes tâches, comme demander une vidéo spécifique.

Envoyer des informations via API 📬🔁


Quand on dit "vous pouvez nous envoyer vos informations par API", cela signifie simplement que vous pouvez utiliser ces routes pour nous dire quels éléments vous voulez dans votre vidéo personnalisée. C'est comme si vous nous envoyiez une commande de pizza avec les garnitures spécifiques que vous voulez.

Déposer vos infos sur un fichier SFPT 📂🌐


Un fichier SFPT est un type de fichier sécurisé que vous pouvez utiliser pour nous envoyer vos informations. C'est une autre manière de nous faire parvenir vos données si vous ne voulez pas utiliser l'API.