Retrieve Play Page

From KickApps Documentation

Overview

Retrieves information for a full media play page. You can use a GET or a POST request when making this call. You can also work with the individual components of a play page, using the following calls:

• Retrieve Media Meta Data
• Email Media
• Add Tags To Media, Members and Groups
• Retrieve Media Ratings
• Rate Media
• Retrieve External Media
• Search

Your request will look something like the following.

http://api.kickapps.com/rest/pp/{mediaType}/{mediaId}/{as}

Note:The comments array will only contain the first 1000 comments. You should refer to the Retrieve Comments call for accessing the full comment list.

Parameters

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

• mediaType. The media type. audio, photo , blog, video. KIT Cloud Social's sample applications use mediaType to check for the Flash player to use. Note that for this call, user is not a valid value.
• mediaId. The id of the media to play. This value is specific to both the as and the type.
• as. The site to search. as is unique for each of the affiliate's sites.

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".

Example Requests

The following requests show an application's call to the REST API, see the relevant sample application code for more details.

Java

NameValuePair[] tokenParams = { new NameValuePair("t", ka_token.getToken()) }; if (ka_token != null) { JSONObject playPageObject = KickAppsHttpClient.doRestCall(KickAppsHttpClient.PLAY_PAGE_URL + mediaType + "/" + mediaId + "/" + as, "POST", tokenParams);if (ka_token != null) { JSONObject playPageObject = KickAppsHttpClient.doRestCall(KickAppsHttpClient.PLAY_PAGE_URL + mediaType + "/" + mediaId + "/" + as, "POST", tokenParams);

C#

The C# sample app uses af as the value for as (affiliate site id).

objclsRestClient = new clsRestClient(); RestUrl = clsRestClient.PLAY_PAGE_URL;

NameValueCollection parameters = new NameValueCollection(); parameters.Add("t", objToken.TOKEN); result = objclsRestClient.doRestCall(RestUrl + mediaType + "/" + mediaId + "/" + af, "POST", parameters); objToken.PAYLOAD = result;

PHP

$as = $ka_token->getAs(); $mediaType = $_REQUEST['mediaType']; $mediaId = $_REQUEST['mediaId'];

$rest_url = PLAY_PAGE_URL .$mediaType ."/". $mediaId."/".$as;

$ch = curl_init($rest_url); curl_setopt ($ch, CURLOPT_POST, 1); curl_setopt ($ch, CURLOPT_POSTFIELDS, 't='.$ka_token->getToken()); curl_setopt($ch, CURLOPT_HEADER, false); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); $buf=curl_exec ($ch); curl_close ($ch);

JSON Payload

On success, a payload that begins with status":"1","error":""

{"status":"1","error":"", "comments":[{}], "latest":[{}], "media":{}, "mostViewed":[{}], "topRated":[{}], "contest":[{}] }

• comments. A nested object that contains the following for each comment.

dayOfMonth month hour:minute:second GMT

• latest/topRated/mostViewed. A nested object that lists the following information for the 25 most recent, top rated, or frequently viewed files uploaded for the media type.

• media. The media file and related information associated with the given play page.

• contest. A nested object that contains the following for the contest this media object is entered in. This will be empty if the media object is not a contest entry.

List of Kit Cloud Social 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.