Search

From KickApps Documentation

Search for keyword tags and display media items by type (audio, video and photo files, along with members and blogs). You can make an HTTP POST or GET request when making this call.

Your request will look something like the following:

http://api.kickapps.com/rest/search/{as}

Note: Our RSS API offers a more comprehensive set of sorting and filtering features for most search queries. Documentation for our RSS API is available here:

RSS Feed API

Parameters

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

• as. The site that you are searching. Each affiliate site has a unique as.

Post Parameters

For the first search call, use the following values, pgNum "1", totPages "1" and totSize "0". The server will return the actual values for these post parameters, given your search criteria.

• 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".
• includeAudio. Optional. on or off. Default is on. Whether or not to search audio files.
• includePhoto. on or off. Default is on. Whether or not to search photos.
• includeVideo. on or off. Default is on. Whether or not to search video files.
• includeSets. on or off. Default is on. Whether or not to search sets.
• includeUser. on or off. Default is on. Whether or not to search members.
• includeBlog. on or off. Default is on. Whether or not to search blogs.
• pgNum. The current page number in the search results. Five results are displayed on each page. For your first call, set pgNum to "1". For subsequent calls, set pgNum to the page you want to display.
• pageSize. The number of results to display on each page.
• totPage. The total number of pages returned. Each page contains five search results. For your first call, set totPages to "1", for subsequent calls, set pgNum to the total number of pages you want to display to the member or to the value for totPages returned by the server.
• totSize. Required if using pagination. Total number of records.
• keywords. A comma separated list of the term or terms to search for. Use URL-encoded space characters (%20) to search for multi-word terms. If you do not specify keyword, the search will return all results. For example, if includeAudio=On and includeVideo=On and no values for keyword were specified, then the search results will return all audio and video files for the site.
• searchType. The sort ordering to use. Default is "recent". Values are: recent, popular, commented, rating, items (for sets only).
• meta. The meta-data has a format of <name>=<value>. To search for more than two meta-data, you can use a semicolon separated each meta-data pairs. If a value is not provided using either "name;name=value" or "name=;name=value", the results will match for any media item with the meta-data name regardless of the values of the meta item.
• metaCreator. Username of the member who added the meta-data. This parameter can be use if the value of meta has been added. If not, we will ignore the searching on metaCreator.

Example Requests

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

PHP

includeAudio, includeVideo, includePhoto can each be either "on" or "off"

$ka_token=$_SESSION['token'];

if ($ka_token == "" || $ka_token->getToken() == "") {
//Since token is null user is not logged in send them back
redirect(dirname($_SERVER['PHP_SELF'])."/login.php");
}
		
$as = $ka_token->getAs();
$keywords = $_REQUEST['keywords'];

$rest_url = SEARCH_PAGE_URL .$as;

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

curl_close ($ch);

JSON Payload

On success, a return that begins with "totSize":"","totPages":"","status":"1","error":"" where:

• totSize. The total number of comments posted by the member.
• totPages. The total number of pages that the comments will display on.
• status. 1 if the call was a success. -1 if the call produced an error.
• error. If the call status is -1, error will contain descriptive text for the error.

The payload will contain the following for each search result:

dayofweek, month day, time AMorPM

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.