Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tree: 858dec0129
Fetching contributors…

Cannot retrieve contributors at this time

65 lines (56 sloc) 1.696 kb

Sites

A site is the destination or marketplace for an individual, distributor, or curator that has packages of videos available for purchase.

Information for a site, including the available packages and videos, can be retrived via the call below:

Definition:

GET /sites/:id

Request:

$ curl -X GET -H "Authorization: Bearer <access_token>" \
  "https://api.vhx.tv/sites/:id"

Response:

{
  "id": 1,
  "uri": "https://api.vhx.tv/sites/1",
  "title": "My site",
  "description": "My site description.",
  "domain": "mymovie.com",
  "subdomain": "mymovie.vhx.tv",
  "key": "mymovie",
  "color": "#000000",
  "facebook_url": "https://facebook.com/ksheurs",
  "twitter_name": "ksheurs",
  "packages": [{
    "id": 1,
    "uri": "https://api.vhx.tv/packages/1",
    "name": "My package",
    "description": "My package description.",
    "sku": "my-sku",
    "price": {
      "cents": 500,
      "currency": "USD",
      "format": "$5.00"
    },
    "trailer_url": "https://vimeo.com/2",
    "trailer_image": "https://cdn.vhx.tv/assets/vhx-disco.png",
    "videos_count": 1
  }],
  "videos": [{
    "id": 1,
    "uri": "https://api.vhx.tv/videos/1",
    "title": "My video",
    "description": "My video description.",
    "duration": 9586560,
    "thumbnail_image": "https://cdn.vhx.tv/assets/vhx-disco.png",
    "subtitles": [
      { "language": "Spanish", "uri": "https://cdn.vhx.tv/assets/spanish.srt", "type": "srt" },
      { "language": "German",  "uri": "https://cdn.vhx.tv/assets/german.vtt", "type": "webvtt" },
      { "language": "Chinese", "uri": "https://api.vhx.tv/videos/2", "type": "video" }
    ],
    "files_count": 5
  }]
}
Jump to Line
Something went wrong with that request. Please try again.