Documentation

Get Video Thumbnails

From KickApps Documentation

Jump to: navigation, search

The purpose of this API is to retrieve a list of all thumbnail images that can be set as the thumbnail image for a video. This list can include:

  • images that were captured from the video during the encoding process
  • an image uploaded by the user specifically to use as a thumbnail for the given video
  • the default video thumbnail image set for the given asID

Contents

Request

HTTP Verb

GET

URI 

http://api.kickapps.com/rest/customers/asId/videos/videoId/thumbnails

URI Parameters

As shown above, your call will include the following parameters:

  • asId. The affiliate site ID for the site to which the given video belongs.
  • videoId. The ID of the video.


Post Parameters

  • t. String. Required. Your access permissions.
  • callback. String. Optional. The name of your JavaScript callback function.
  • clientIP. String. Optional. Use the clientIP parameter to pass the IP address of the user making the call. If the IP has been blocked by the webmaster under the Affiliate Center -> Manage Members section, an error message will be returned starting with "status":"-1","error":"This IP address has been banned".

Permissions

Any user with a valid token for the given AS ID should be able to access this API to retrieve all captured thumbnails for any video within that AS ID.

Response: Success

HTTP Status Code

200 OK

Note: The default system thumbnail for the video mediaType will always have "thumbId1". If an administrator uploads a custom default thumbnail for the video mediaType, its "id" will be "thumbId2". 

{
    "status": "1",
    "thumbnails": [
        {
            "id": "thumbId1",
            "isCurrentThumbnail": true,
            "isDefaultVideoThumbnail": true,
            "urls": {
                "48x48": "http://path/to/thumbId1_48x48.jpg",
                "100x75": "http://path/to/thumbId1_100x75.jpg",
                "160x120": "http://path/to/thumbId1_160x120.jpg",
                "320x240": "http://path/to/thumbId1_320x240.jpg",
                "420x315": "http://path/to/thumbId1_420x315.jpg",
                "730x550": "http://path/to/thumbId1_730x550.jpg"
            }
        },
        {
            "id": "thumbId2",
            "isCurrentThumbnail": false,
            "isDefaultVideoThumbnail": false,
            "urls": {
                "48x48": "http://path/to/thumbId2_48x48.jpg",
                "100x75": "http://path/to/thumbId2_100x75.jpg",
                "160x120": "http://path/to/thumbId2_160x120.jpg",
                "320x240": "http://path/to/thumbId2_320x240.jpg",
                "420x315": "http://path/to/thumbId2_420x315.jpg",
                "730x550": "http://path/to/thumbId2_730x550.jpg"
            }
        },
        {
            "id": "thumbId3",
            "isCurrentThumbnail": false,
            "isDefaultVideoThumbnail": false,
            "urls": {
                "48x48": "http://path/to/thumbId3_48x48.jpg",
                "100x75": "http://path/to/thumbId3_100x75.jpg",
                "160x120": "http://path/to/thumbId3_160x120.jpg",
                "320x240": "http://path/to/thumbId3_320x240.jpg",
                "420x315": "http://path/to/thumbId3_420x315.jpg",
                "730x550": "http://path/to/thumbId3_730x550.jpg"
            }
        },
        {
            "id": "thumbId4",
            "isCurrentThumbnail": false,
            "isDefaultVideoThumbnail": false,
            "urls": {
                "48x48": "http://path/to/thumbId4_48x48.jpg",
                "100x75": "http://path/to/thumbId4_100x75.jpg",
                "160x120": "http://path/to/thumbId4_160x120.jpg",
                "320x240": "http://path/to/thumbId4_320x240.jpg",
                "420x315": "http://path/to/thumbId4_420x315.jpg",
                "730x550": "http://path/to/thumbId4_730x550.jpg"
            }
        },
        {
            "id": "thumbId5",
            "isCurrentThumbnail": false,
            "isDefaultVideoThumbnail": false,
            "urls": {
                "48x48": "http://path/to/thumbId5_48x48.jpg",
                "100x75": "http://path/to/thumbId5_100x75.jpg",
                "160x120": "http://path/to/thumbId5_160x120.jpg",
                "320x240": "http://path/to/thumbId5_320x240.jpg",
                "420x315": "http://path/to/thumbId5_420x315.jpg",
                "730x550": "http://path/to/thumbId5_730x550.jpg"
            }
        },
        {
            "id": "thumbId6",
            "isCurrentThumbnail": false,
            "isDefaultVideoThumbnail": true,
            "urls": {
                "48x48": "http://path/to/thumbId6_48x48.jpg",
                "100x75": "http://path/to/thumbId6_100x75.jpg",
                "160x120": "http://path/to/thumbId6_160x120.jpg",
                "320x240": "http://path/to/thumbId6_320x240.jpg",
                "420x315": "http://path/to/thumbId6_420x315.jpg",
                "730x550": "http://path/to/thumbId6_730x550.jpg"
            }
        },
        {
            "id": "thumbId7",
            "isCurrentThumbnail": false,
            "isDefaultVideoThumbnail": true,
            "urls": {
                "48x48": "http://path/to/thumbId7_48x48.jpg",
                "100x75": "http://path/to/thumbId7_100x75.jpg",
                "160x120": "http://path/to/thumbId7_160x120.jpg",
                "320x240": "http://path/to/thumbId7_320x240.jpg",
                "420x315": "http://path/to/thumbId7_420x315.jpg",
                "730x550": "http://path/to/thumbId7_730x550.jpg"
            }
        }
    ]
}

Response: Error

HTTP Status Code

400

Invalid Token 

{
  "status": "-1",
  "message": "Invalid token"
}

No video ID or video ID is marked as deleted 

{
  "status": "-1",
  "message": "There is not a video with videoId #{the video ID passed into the URI}."
}

No thumbnails available for the video yet (still being encoded) 

{
  "status": "-1",
  "message": "There are no thumbnails available for video ID #{videoId}.  The video is still being processed.  Please try again later."
}


List of KickApps API Calls


Note: Occasionally (and without advanced warning) we modify our API calls by adding new parameters in the response payload. Please keep this in mind when designing your strategy for parsing our responses.

Retrieved from "http://www.kickapps.com/documentation/index.php/Get_Video_Thumbnails"