loader image

The Vidata Data API

Creating and Managing User Tokens

As soon as your Vidata account is created, you’ll be able to generate API tokens on your user account.

You can create multiple tokens if you ever need to track your API calls.

Authentication

– All upload requests must use SSL (https://, not http://).
– Your API token will be used for authentication, by setting the value of the vkey parameter in every API call

For example:

GET https://api.vidata.io/v1/project/7988fb58-4730-4bf8-8f89-efe8b632a820?vkey=xxx-xxx-xxx-xxx

For brevity sake, that token will be omitted in the rest of the API documentation.

Project

> Project #get

> Project #variables

Project #Get

Retrieve details about a project.

GET https://api.vidata.io/v1/project/{project_id}

Example Project #Get Request

The Request

GET https://api.vidata.io/v1/project/7988fb58-4730-4bf8-8f89-efe8b632a820

The Response

{ "CreatedOnUtc": "17/04/2018 08:43:47", "CreatedOnLocal": "17/04/2018 10:43:47", "UpdatedOnUtc": "20/10/2021 14:55:17", "UpdatedOnLocal": "20/10/2021 16:55:17", "Administrator": "caroline@vidata.io", "Color": "#29B6F6", "Cover": "59604ddb-fdcc-40b6-bdf7-bc089a4d9fb2", "Description": "", "EmailService": "None", "GoogleAnalyticsId": "", "HeaderList": [ "TXT_USEREMAIL", ], "Id": "7988fb58-4730-4bf8-8f89-efe8b632a820", "IsOutputExcelActivated": "False", "IsOutputMandrillActivated": "True", "IsSendMailActivated": "False", "Name": "AFNOR", "OutputCoverFrame": "1", "OutputExcelFilename": "", "OutputMandrillFromEmail": "valentine@vidata.io", "OutputMandrillFromName": "★Vidata", "OutputMandrillReplyTo": "", "OutputMandrillSubject": "Template Vidata", "OutputMandrillTemplateSlug": "mail-video-perso-site-web", "PagePlayerLink": "https://marketing.afnor.org/video.php?vidataId={videoslug}", "PlayerColor": "#4b5b7f", "ProjectState": "Live", "ProjectType": "0", "TwitterText": "", "SelectedPlayer": "", "VariableKeys": [ "TXT_NAME", "TXT_METIER", "TXT_USEREMAIL", ], "Videos": [ { "UtcDateCreated": "17/04/2018 08:29:47", "UtcDateUpdated": "29/01/2019 10:03:41", "Administrator": "", "CoverUrl": "https://vdtcariboustorage.blob.core.windows.net/video-cover-95d0224d-fc6f-4b55-88bf-a3e1c4400cf2/09c93f57-1122-416e-9a09-ea13247e7acb.png", "DownloadUri": "https://vdt-caribou.s3.amazonaws.com/video-95d0224d-fc6f-4b55-88bf-a3e1c4400cf2/d0c93be0-5451-4397-b2cc-38604f8db756-Resolution540p.mp4", "GoogleDriveFolderId": "1Vv0x22_6Yc-0HViJs1O5a1sGxX_dQuiR", "Id": "95d0224d-fc6f-4b55-88bf-a3e1c4400cf2", "IsPublic": "False", "LowerQualityVideoId": "00000000-0000-0000-0000-000000000000", "PackageUri": "", "Quality": "Resolution540p", "State": "Live", "Title": "AFNOR > Final - PoCv1", "TopQualityVideoId": "00000000-0000-0000-0000-000000000000", "TotalFrame": "1200", "VzaarVideoId": "", }, ], "VideoTemplateId": "95d0224d-fc6f-4b55-88bf-a3e1c4400cf2", }

Project #Variables

Retrieve the list of variables for a Project.

GET https://api.vidata.io/v1/project/{project_id}/variables

Example Project #Variables Request

The Request

GET https://api.vidata.io/v1/project/7988fb58-4730-4bf8-8f89-efe8b632a820/variables

The Response

{
  {
    "DefaultValue": "Matthieu Rogier;",
    "ExampleValue": "Matthieu Rogier;",
    "MaxLength": "100;",
    "Type": "Text;",
    "Value": ";",
    "Key": "TXT_NAME;",
  },  {
    "DefaultValue": "Métrologue;",
    "ExampleValue": "Métrologue;",
    "MaxLength": "100;",
    "Type": "Text;",
    "Value": ";",
    "Key": "TXT_METIER;",
  },}

Vidata

> Vidata #get

> Vidata #post

> Vidata #delete

> Vidata #variables

Vidata #Get

Retrieve details about a project’s Vidata .

GET https://api.vidata.io/v1/vidata/{vidata_id}/?projectId={project_id}

Example Vidata #Get Request

The Request

GET https://api.vidata.io/v1/vidata/haquozcpa4j/?projectId=7988fb58-4730-4bf8-8f89-efe8b632a820

The Response

{ "Id": "haquozcpa4j;", "ProjectId": "7988fb58-4730-4bf8-8f89-efe8b632a820;", "PartitionKey": "7988fb58-4730-4bf8-8f89-efe8b632a820;", "LocalDateCreated": "17/04/2018 10:45:36;", "LocalDateUpdated": "17/04/2018 10:50:21;", "UserEmail": "alan@vidata.io;", "Variables": { "Civilité": "Monsieur", "TXT_NAME": "Alan", "TXT_METIER": "Directeur artistique", } "Title": "AFNOR > Final - PoCv1;", "Description": ";", "VidataUri": "https://marketing.afnor.org/video.php?vidataId=haquozcpa4j;", "DownloadUri": "https://vdt-caribou.s3.amazonaws.com/video-95d0224d-fc6f-4b55-88bf-a3e1c4400cf2/192ea9cb-306a-4287-b7f2-2cd145da0a1f-Resolution540p.mp4;", "CoverImgUri": "https://vdtcariboustorage.blob.core.windows.net/video-cover-95d0224d-fc6f-4b55-88bf-a3e1c4400cf2/a1467c3a-9c4a-4b42-9fa6-3c3b770a29e8.png;", "GoogleShortUrl": ";", "VideoQuality": "Resolution540p;", "VzaarVideoId": ";", "WistiaVideoId": ";", "YoutubeVideoId": ";", "FacebookVideoId": ";", "TwitterText": ";", "GoogleAnalyticsId": ";", "ComScoreId": ";", "UniqueId": "eb5c4c36-2d60-4de0-be1d-7d4929d50e90;", "PagePlayerConfiguration": ";", }

Vidata# Post

Create a new Vidata (Video + Data) in your account.

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

Parameters

Example Vidata #Post Request

The Request

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

{ key: "7988fb58-4730-4bf8-8f89-efe8b632a820", variables: { "TXT_USEREMAIL": "test@vidata.io", "TXT_NAME": "Matthieu Rogier", "TXT_METIER": "Métrologue", } }

The Response

If the Vidata is created successfully, the API will respond with an HTTP 201 Created status code, and the VidataId of the newly created vidata.

{
    "VidataId" : "tnax8961m27"
}

VIDATA #Delete

Delete a vidata of a project.


DELETE https://api.vidata.io/v1/vidata/{vidata_id}

Example VIDATA #Delete Request

The Request

DELETE https://api.vidata.io/v1/vidata/haquozcpa4j

The Response

If the Vidata is successfully deleted, the API will respond with an HTTP 200 OK status code.

Vidata# Variables

Retrieve the variables value of the Vidata.


GET https://api.vidata.io/v1/vidata/{vidata_id}/variables?projectId={project_id}

Example Vidata #Variables Request

The Request

GET https://api.vidata.io/v1/vidata/haquozcpa4j/variables?projectId=7988fb58-4730-4bf8-8f89-efe8b632a820

The Response


{
"TXT_NAME": "Alan",
"TXT_METIER": "Directeur artistique",
}

Video

Video #get

Video #Get

Retrieve details about a video.


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

Example Video #Get Request

The Request

GET https://api.vidata.io/v1/video/95d0224d-fc6f-4b55-88bf-a3e1c4400cf2

The Response


{
"UtcDateCreated": "17/04/2018 08:29:47;",
"UtcDateUpdated": "29/01/2019 10:03:41;",
"Administrator": ";",
"CoverUrl": "https://vdtcariboustorage.blob.core.windows.net/video-cover-95d0224d-fc6f-4b55-88bf-a3e1c4400cf2/09c93f57-1122-416e-9a09-ea13247e7acb.png;",
"DownloadUri": "https://vdt-caribou.s3.amazonaws.com/video-95d0224d-fc6f-4b55-88bf-a3e1c4400cf2/d0c93be0-5451-4397-b2cc-38604f8db756-Resolution540p.mp4;",
"GoogleDriveFolderId": "1Vv0x22_6Yc-0HViJs1O5a1sGxX_dQuiR;",
"Id": "95d0224d-fc6f-4b55-88bf-a3e1c4400cf2;",
"IsPublic": "False;",
"LowerQualityVideoId": "00000000-0000-0000-0000-000000000000;",
"PackageUri": "https://vdtcariboustorage.blob.core.windows.net/videotemplate-95d0224d-fc6f-4b55-88bf-a3e1c4400cf2/sources-live.zip?sv=2018-03-28&sr=b&sig=DGfOOic8iW%2BsR%2F14w5zry0a1HqnGU1tjIgG%2BkSVGMpQ%3D&st=2021-11-17T16%3A02%3A16Z&se=2021-11-17T20%3A07%3A16Z&sp=r;",
"Quality": "Resolution540p;",
"State": "Live;",
"Title": "AFNOR > Final - PoCv1;",
"TopQualityVideoId": "00000000-0000-0000-0000-000000000000;",
"TotalFrame": "1200;",
"VzaarVideoId": ";",
}

Vidata Part

VideoPart #post

VideoPart# Post

Create a new VideoPart


POST https://api.vidata.io/v1/videopart

Parameters

Example VideoPart #Post Request

The Request

POST https://api.vidata.io/v1/videopart


{
key: "7988fb58-4730-4bf8-8f89-efe8b632a820",
videoId: "95d0224d-fc6f-4b55-88bf-a3e1c4400cf2",
partId: "a6cebced-8b1a-4280-bee5-ea5016b2d007",
variables: {
"TXT_USEREMAIL": "test@vidata.io",
                "TXT_NAME": "Matthieu Rogier",
                "TXT_METIER": "Métrologue",
                }
}

 

The Response

If the VideoPart is created successfully, the API will respond with an HTTP 201 Created status code.

Upload

> Upload #post

Upload #Post

Upload a new file in your Vidata account.


POST https://api.vidata.io/v1/upload

 

Parameters

Example Upload #Post Request

Status : 200 Created
Location : https://api.vidata.io/v1/Upload


{
    "Path" : "tnax8961m27",
    "Filename" : "tnax8961m27.png"
}

 

The Response

If the file is uploaded successfully, the API will respond with an HTTP 200 OK status code, the Path and the Filename on the Vidata server.

Upload file and attach to a Vidata

To attach a file to a Vidata :

1 – Upload the file like describe previously, you will get a new Filename (for example file1234.png

2 – Attach this file to the Vidata
POST https://api.vidata.io/v1/vidata


{
    key: "7988fb58-4730-4bf8-8f89-efe8b632a820",
    variables: {

"TXT_USEREMAIL": "test@vidata.io",
                        "TXT_NAME": "Matthieu Rogier",
                        "TXT_METIER": "Métrologue",
                            }
}
contacts
Discover the benefits of Personalised Video
An expert will present the Vidata Solution to you in detail to increase the profitability of your marketing actions and build customer loyalty.
Inscription à la newsletter de Vidata

Abonnez-vous à notre newsletter mensuelle et ne passer plus à côté de nos études et de nos événements