The Vidata Data API

Authentication

- All upload requests must use SSL (https://, not http://).
- The required key parameter will be used for authentication.

Project #Get

Retrieve details about a project.


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

Example Project #Get Request

The Request

GET https://api-dromadaire.vidata.io/v1/project/61cb0ff0-857a-4038-85a2-216d1c82970d

The Response

            
{
"CreatedOnUtc": "5/15/2018 2:39:39 PM",
"CreatedOnLocal": "5/15/2018 4:39:39 PM",
"UpdatedOnUtc": "5/16/2018 2:04:37 PM",
"UpdatedOnLocal": "5/16/2018 4:04:37 PM",
"Administrator": "matthieu@vidata.io",
"Cover": "cd414d41-7f6f-433e-a3ef-4a01d27ada05",
"Description": "",
"EmailService": "None",
"GoogleAnalyticsId": "",
"HeaderList": [
"TXT_USEREMAIL",
],
"Id": "61cb0ff0-857a-4038-85a2-216d1c82970d",
"IsOutputExcelActivated": "False",
"IsOutputMandrillActivated": "True",
"IsSendMailActivated": "False",
"Name": "Vidata Documentation",
"OutputCoverFrame": "1",
"OutputExcelFilename": "",
"OutputMandrillFromEmail": "valentine@vidata.io",
"OutputMandrillFromName": "★Vidata",
"OutputMandrillReplyTo": "",
"OutputMandrillSubject": "Template Vidata",
"OutputMandrillTemplateSlug": "mail-video-perso-site-web",
"PagePlayerLink": "https://vidata.io/Votre-Video/{videoslug}",
"ProjectState": "Live",
"ProjectType": "2",
"TwitterText": "",
"SelectedPlayer": "standard",
"VariableKeys": [
"TXT_prenom",
"TXT_mois",
"TXT_moisfilleul",
"TXT_moisrestant",
"TXT_amis",
"TXT_USEREMAIL",
],
"Videos": [
{
"UtcDateCreated": "5/14/2018 3:11:33 PM",
"UtcDateUpdated": "5/15/2018 2:50:47 PM",
"Administrator": "",
"CoverUrl": "https://vdtcariboustorage.blob.core.windows.net/video-cover-30c1ec3c-7b89-4567-9df9-8651ac4a2a10/d9e536df-ff8d-4bc3-80a9-61373454240d.gif",
"DownloadUri": "https://vdt-caribou.s3.amazonaws.com/video-30c1ec3c-7b89-4567-9df9-8651ac4a2a10/138a0b66-a825-4abf-9af0-3238ce00a240-Resolution540p.mp4",
"GoogleDriveFolderId": "1pn3yH7jNyy-7ty3Pa3MPE1wmjpDRdnru",
"Id": "30c1ec3c-7b89-4567-9df9-8651ac4a2a10",
"IsPublic": "False",
"LowerQualityVideoId": "00000000-0000-0000-0000-000000000000",
"PackageUri": "",
"Quality": "Resolution540p",
"State": "Live",
"Title": "Mai-VIDAP>0 pour 1MOIS",
"TopQualityVideoId": "00000000-0000-0000-0000-000000000000",
"TotalFrame": "625",
"VzaarVideoId": "0",
},
],
"VideoId": "00000000-0000-0000-0000-000000000000",
}

Project #Variables

Retrieve the list of variables for a Project.


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

Example Project #Variables Request

The Request

GET https://api-dromadaire.vidata.io/v1/project/61cb0ff0-857a-4038-85a2-216d1c82970d/variables

The Response

        
{
  {
"DefaultValue": "Caroline;",
"ExampleValue": "Caroline;",
"MaxLength": "30;",
"Type": "Text;",
"Value": ";",
"Key": "TXT_prenom;",
}, {
"DefaultValue": "1 mois;",
"ExampleValue": "2 mois;",
"MaxLength": "2;",
"Type": "Text;",
"Value": ";",
"Key": "TXT_mois;",
}, {
"DefaultValue": "1 mois;",
"ExampleValue": "1 mois;",
"MaxLength": "30;",
"Type": "Text;",
"Value": ";",
"Key": "TXT_moisfilleul;",
}, {
"DefaultValue": "4;",
"ExampleValue": "4;",
"MaxLength": "2;",
"Type": "Text;",
"Value": ";",
"Key": "TXT_moisrestant;",
}, {
"DefaultValue": "2;",
"ExampleValue": "2;",
"MaxLength": "2;",
"Type": "Text;",
"Value": ";",
"Key": "TXT_amis;",
},}

Vidata #Get

Retrieve details about a project's Vidata .


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

Example Vidata #Get Request

The Request

GET https://api-dromadaire.vidata.io/v1/vidata/u46n2x1ljp5/?projectId=61cb0ff0-857a-4038-85a2-216d1c82970d

The Response

                
{
"Id": "u46n2x1ljp5;",
"ProjectId": "61cb0ff0-857a-4038-85a2-216d1c82970d;",
"PartitionKey": "61cb0ff0-857a-4038-85a2-216d1c82970d;",
"LocalDateCreated": "5/15/2018 4:40:53 PM;",
"LocalDateUpdated": "5/15/2018 4:42:42 PM;",
"UserEmail": "matthieu@vidata.io;",
"Variables": {
"TXT_prenom": "Paul",
"TXT_mois": "2 mois",
"TXT_moisfilleul": "1 mois",
"TXT_moisrestant": "4",
"TXT_amis": "2",
}
"Title": "Mai-VIDAP>0 pour 1MOIS;",
"Description": ";",
"VidataUri": "https://vidata.io/Votre-Video/u46n2x1ljp5;",
"DownloadUri": "https://vdt-caribou.s3.amazonaws.com/video-30c1ec3c-7b89-4567-9df9-8651ac4a2a10/478e5e7a-954b-46c5-a680-afd339dbf42f-Resolution540p.mp4;",
"CoverImgUri": "https://vdtcariboustorage.blob.core.windows.net/video-cover-30c1ec3c-7b89-4567-9df9-8651ac4a2a10/bc92abb8-1b30-4c08-bf33-5ed2a6894a21.gif;",
"GoogleShortUrl": ";",
"VideoQuality": "Resolution540p;",
"VzaarVideoId": ";",
"WistiaVideoId": ";",
"YoutubeVideoId": ";",
"FacebookVideoId": ";",
"TwitterText": ";",
"GoogleAnalyticsId": ";",
"ComScoreId": ";",
"UniqueId": "a3c206b0-a1ea-4104-bc03-ca4cde219663;",
"PagePlayerConfiguration": ";",
}

Vidata# Post

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


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

Parameters

Parameter Name Description
Key The id of the project
Variables Dictionary with variables of the vidata to create

Example Vidata #Post Request

The Request

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

            
{
key: "61cb0ff0-857a-4038-85a2-216d1c82970d",
variables: {
"TXT_USEREMAIL": "test@vidata.io",
                "TXT_prenom": "Caroline",
                "TXT_mois": "1 mois",
                "TXT_moisfilleul": "1 mois",
                "TXT_moisrestant": "4",
                "TXT_amis": "2",
                }
}
                

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-dromadaire.vidata.io/v1/vidata/{vidata_id}

Example VIDATA #Delete Request

The Request

DELETE https://api-dromadaire.vidata.io/v1/vidata/u46n2x1ljp5

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-dromadaire.vidata.io/v1/vidata/{vidata_id}/variables?projectId={project_id}

Example Vidata #Variables Request


The Request

GET https://api-dromadaire.vidata.io/v1/vidata/u46n2x1ljp5/variables?projectId=61cb0ff0-857a-4038-85a2-216d1c82970d

The Response

            
{
"TXT_prenom": "Paul",
"TXT_mois": "2 mois",
"TXT_moisfilleul": "1 mois",
"TXT_moisrestant": "4",
"TXT_amis": "2",
}

Magic Link #Post

Update the options of a project's Magic Link.

        
        POST https://api-dromadaire.vidata.io/v1/project/{project_id}/magiclink
    

Parameters

Parameter Name Description
DefaultCover The link to the default cover of the Magic Link
DefaultVideo The link to the default video Magic Link
IsActive A boolean indicating whether or not the Magic Link is activated for the project.
IsAutoGenerationActive A boolean indicating whether or not the auto-generation based on the parameters is activated for the project.

Example Magic Link #Post Request

The Request

POST https://api-dromadaire.vidata.io/v1/project/{project_id}/magiclink

            
{
"DefaultCover": ";",
"DefaultVideo": ";",
"IsActive": "False;",
"IsAutoGenerationActive": "False;",
}

The Response

If the Magic Link is updated successfully, the API will respond with an HTTP 200 OK status code.

CTA #Get

Retrieve the list of Call to actions of a project.


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

Example CTA #Get Request

The Request

GET https://api-dromadaire.vidata.io/v1/project/61cb0ff0-857a-4038-85a2-216d1c82970d/calltoactions

The Response

            
{
"CTAList" : [
{" Id": "CTA_1;",
" IsActive": "True;",
" StartTime": "20;",
" EndTime": "30;",
" Wording": ";",
" Link": ";",
" CSSFilename": ";",
},] }

CTA #Post

Create or Update a CTA for a project.

        
        POST https://api-dromadaire.vidata.io/v1/project/{project_id}/calltoactions
    

Parameters

Parameter Name Description
Id The unique ID of the CTA.
IsActive A boolean indicating whether or not the CTA is activated.
StartTime The integer value of the second the CTA start being displayed.
EndTime The integer value of the second the CTA stop being displayed.
Wording The message displayed in the CTA.
Link The URL address of the CTA's link.
CSSFilename The name of the style sheet for the CTA.

Example CTA #Post Request

The Request

POST https://api-dromadaire.vidata.io/v1/project/{project_id}/calltoactions

            
{
"Id": "CTA_1;",
"IsActive": "True;",
"StartTime": "20;",
"EndTime": "30;",
"Wording": ";",
"Link": ";",
"CSSFilename": ";",
}

The Response

If the Call to actions is updated successfully, the API will respond with an HTTP 200 OK status code.

CTA #Delete

Delete a Call to actions of a project.


DELETE https://api-dromadaire.vidata.io/v1/project/{project_id}/calltoactions

Example CTA #Delete Request

The Request

DELETE https://api-dromadaire.vidata.io/v1/project/61cb0ff0-857a-4038-85a2-216d1c82970d/calltoactions/CTA_1

The Response

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

Video

> Video #get

Video #Get

Retrieve details about a video.


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

Example Video #Get Request

The Request

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

The Response

            
{
"UtcDateCreated": "5/14/2018 3:11:33 PM;",
"UtcDateUpdated": "5/15/2018 2:50:47 PM;",
"Administrator": ";",
"CoverUrl": "https://vdtcariboustorage.blob.core.windows.net/video-cover-30c1ec3c-7b89-4567-9df9-8651ac4a2a10/d9e536df-ff8d-4bc3-80a9-61373454240d.gif;",
"DownloadUri": "https://vdt-caribou.s3.amazonaws.com/video-30c1ec3c-7b89-4567-9df9-8651ac4a2a10/138a0b66-a825-4abf-9af0-3238ce00a240-Resolution540p.mp4;",
"GoogleDriveFolderId": "1pn3yH7jNyy-7ty3Pa3MPE1wmjpDRdnru;",
"Id": "30c1ec3c-7b89-4567-9df9-8651ac4a2a10;",
"IsPublic": "False;",
"LowerQualityVideoId": "00000000-0000-0000-0000-000000000000;",
"PackageUri": "https://vdtcariboustorage.blob.core.windows.net/videotemplate-30c1ec3c-7b89-4567-9df9-8651ac4a2a10/sources-live.zip?sv=2017-07-29&sr=b&sig=eKn1bd0Fa9ChbBRcISOo8TSaaSzqCCrNMB7Fm2K0O9M%3D&st=2018-05-26T02%3A03%3A52Z&se=2018-05-26T06%3A08%3A52Z&sp=r;",
"Quality": "Resolution540p;",
"State": "Live;",
"Title": "Mai-VIDAP>0 pour 1MOIS;",
"TopQualityVideoId": "00000000-0000-0000-0000-000000000000;",
"TotalFrame": "625;",
"VzaarVideoId": "0;",
}

Upload #Post

Upload a new file in your Vidata account.

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

Parameters

Parameter Name File
Required ProjectId or API_Password The id of the project
Variables Required unless url is specified. The media file, multipart-form encoded into the request body.
Url NOT READY Required unless file is specified. The web or FTP location of the media file to import.

Example Upload #Post Request

Status : 200 Created
Location : https://api-dromadaire.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://vdt-caribou-api-autodeploy.azurewebsites.net/v1/vidata

                        
{
    key: "61cb0ff0-857a-4038-85a2-216d1c82970d",
    variables: {

"TXT_USEREMAIL": "test@vidata.io",
                        "TXT_prenom": "Caroline",
                        "TXT_mois": "1 mois",
                        "TXT_moisfilleul": "1 mois",
                        "TXT_moisrestant": "4",
                        "TXT_amis": "2",
                            }
}
                

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