Générer une Vidata

Obtenir votre clé

Pour générer une Vidata ou vidéo personnalisée, vous aurez besoin de la clé de votre Projet>. Dans notre Plateforme, ouvrez votre Projet, cliquez sur Distribute, vous trouverez un onglet API.

Exemple
    


Connaître la liste de variables

Chaque projet est associé à une vidéo et celle-ci possède une liste de variables.
Vous pouvez les découvrir depuis notre plateforme en ouvrant le Template vidéo que vous avez selectionné pour votre projet et explorer la liste dans l'onglet Variables.
Il est aussi possible de passer par l'API pour les récuperer. En utilisant la requête :


GET https://api-dromadaire.vidata.io/v1/video/{video_id}/variables

Exemple de requête

GET https://api-dromadaire.vidata.io/v1/video/30c1ec3c-7b89-4567-9df9-8651ac4a2a10/variables

Réponse de votre requête


{
    "Texts":
    [
      {
"ExampleValue": "Caroline;",
"MaxLength": "30;",
"Name": "TXT_prenom;",
"DefaultValue": "Caroline;",
{
"ExampleValue": "2 mois;",
"MaxLength": "2;",
"Name": "TXT_mois;",
"DefaultValue": "1 mois;",
{
"ExampleValue": "1 mois;",
"MaxLength": "30;",
"Name": "TXT_moisfilleul;",
"DefaultValue": "1 mois;",
{
"ExampleValue": "4;",
"MaxLength": "2;",
"Name": "TXT_moisrestant;",
"DefaultValue": "4;",
{
"ExampleValue": "2;",
"MaxLength": "2;",
"Name": "TXT_amis;",
"DefaultValue": "2;",
], "Images": [ ], "Videos": [ ] }

Les types de variables

Maintenant que vous êtez en possession de la liste de vos variables, ils vous reste à savoir comment leur attribuer une valeur. Les variables ont généralement une valeur par défaut qui sera utilisée si la variable ne se trouve pas dans le dictionnaire. Vous avez donc juste à envoyer les variables que vous souhaitez personnaliser.

Variables Textes

Les variables de type texte débutent toujours par "TXT_". Elles peuvent possèder une valeur d'exemple, une valeur par défaut et une taille maximum de caractère.

Exemple
    
"TXT_nom" = "Harnois"

Variables de localisation

Vous pourrez trouvez des variables textes associées à une adresse, elles débutent par "TXT_MAP_" et sont suivi du nom de l'image qui servira pour afficher une carte. Pour cela, vous n'aurez qu'à saisir une adresse dans la variable texte, l'image sera alors mis à jour en fonction de celle-ci.

Exemple
    
"TXT_MAP_IMG_adresse.png" = "21 avenue de la République 75011 Paris"

Variables Images

Les variables de type images débutent par "IMG_". Elles peuvent possèder une valeur par défaut et des dimensions. Pour attribuer une image à une variable, vous devrez d'abord effectuer un Upload du fichier comme expliquer ici. Dans la réponse, vous trouverez le Filename que vous attriburez à la variable image du dictionnaire.

Exemple
    
"IMG_image.png" = "ezk25b34.png"

Variables Images prédéfinies

Certaines variables d'images possèdent des choix prédéfinis PredefinedChoices. Cela signifie que l'image est à sélectionner parmis ces choix. Attribuez alors à cette variable la clé de l'image que vous souhaitez utiliser.

Exemple

PredefinedChoices = {
    "image_1" = "https://storage.vidata.io/video.../siftnus28ln.png",
    "image_2" = "https://storage.vidata.io/video.../2xbrgn2jshr.png"
}
"IMG_image.png" = "image_2"

La requête POST

Vous êtez maintenant en possession de votre clé et de la liste de vos variables, vous pouvez écrire votre requête.


POST https://api-dromadaire.vidata.io/v1/vidata

Paramètres

Nom Description
Key La clé de votre projet
Variables Dictionnaire de variables

Informations

Lorsque vous créez votre dictionnaire, vous devez toujours ajouter
un champ "TXT_USEREMAIL" afin de pouvoir générer votre Vidata.

Exemple de requête

POST https://api-dromadaire.vidata.io/v1/vidata


{
key: "",
variables: {
    "TXT_USERMAIL" : "test@mail.com",
  "TXT_prenom": "Caroline",
                  "TXT_mois": "1 mois",
                  "TXT_moisfilleul": "1 mois",
                  "TXT_moisrestant": "4",
                  "TXT_amis": "2",
                }
}

Réponse

Si la requête est valide, l'API répondra par un statut HTTP 201 Created, et vous retournera le VidataId de votre nouvelle vidéo personnalisée.


{
    "VidataId" : "tnax8961m27"
}

Vidata, une solution distinguée

Vidata prix vidéo personnalisée
Vidata prix vidéo personnalisée
Vidata prix vidéo personnalisée
Vidata prix vidéo personnalisée
Vidata prix vidéo personnalisée
Vidata prix vidéo personnalisée
Vidata prix vidéo personnalisée