VAST API Reference

Our API can create,update,delete VPAID tags for youtube videos

API Endpoint
https://vs.spy-love.com/api/v1
Request Content-Types: application/x-www-form-urlencoded
Response Content-Types: application/json
Schemes: https
Version: 0.0.1

Authentication

Authorization

The API uses token based authentication to authenticate users. The format is Bearer {API_KEY}. An API token can be obtained by signing in to vs.spy-love.com, and then going to API section.

name
Authorization
type
apiKey
in
header

Paths

List vasts

GET /vasts
200 OK

The list of VASTs

type
object
Response Example (200 OK) 
{
  "data": [
    {
      "id": 52,
      "name": "Test video",
      "vast_xml_url": "http://vs.spy-love.com/10/Mv1InAQx2e.xml",
      "youtube_videos": [
        {
          "yotubue_video_id": "ZVK4_Ik_8CQ"
        },
        {
          "yotubue_video_id": "AVK4_Ik_8CQ"
        }
      ]
    }
  ]
}

Create vast

POST /vasts
name: string
in formData

VAST name

youtube_video_ids[]: string[]
in formData

Youtube videos ids

200 OK

The VAST

type
object
Response Example (200 OK) 
{
  "data": [
    {
      "id": 52,
      "name": "Test video",
      "vast_xml_url": "http://vs.spy-love.com/10/Mv1InAQx2e.xml",
      "youtube_videos": [
        {
          "yotubue_video_id": "ZVK4_Ik_8CQ"
        },
        {
          "yotubue_video_id": "AVK4_Ik_8CQ"
        }
      ]
    }
  ]
}

Update vast

PUT /vasts/{id}
name: string
in formData

VAST name

youtube_video_ids[]: string[]
in formData

Youtube videos ids

id: integer
in path

The VAST’s unique ID

200 OK
vast

Information about the VAST

Response Example (200 OK) 
{
  "id": 52,
  "name": "Test video",
  "vast_xml_url": "http://vs.spy-love.com/10/Mv1InAQx2e.xml",
  "youtube_videos": [
    {
      "yotubue_video_id": "ZVK4_Ik_8CQ"
    },
    {
      "yotubue_video_id": "AVK4_Ik_8CQ"
    }
  ]
}

Delete vast

DELETE /vasts/{id}
id: integer
in path

The VAST’s unique ID

200 OK

VAST deleted

Schema Definitions

vast: object

id: integer

The VAST’s unique ID

name: string

VAST name

vast_xml_url: string

URL of XML

youtube_videos: youtube_video
youtube_video
Example
{
  "id": 52,
  "name": "Test video",
  "vast_xml_url": "http://vs.spy-love.com/10/Mv1InAQx2e.xml",
  "youtube_videos": [
    {
      "yotubue_video_id": "ZVK4_Ik_8CQ"
    },
    {
      "yotubue_video_id": "AVK4_Ik_8CQ"
    }
  ]
}

youtube_video: object

yotubue_video_id: string

ID of youtube video

Example
{
  "yotubue_video_id": "ZVK4_Ik_8CQ"
}
Documentation by Spectacle