Documentation

Add Tags To Media, Members and Groups

From KickApps Documentation

Jump to: navigation, search

Members can add descriptive keyword tags to media that are then associated to a media id. You can make an HTTP POST or GET request when using this call. The content owner can specify that tags cannot be added to a given mediaId. Each mediaId can have a maximum of 512 characters of associated tags, including the commas or spaces that separate each tag. Your request will look something like the following: 

http://api.kickapps.com/rest/tags/add/{mediaType)/{mediaId/userId/groupId}/{as}
Note: You can now use this call to add tags to members and groups as well as to media.
  • To add tags to members, set mediaType to user and use the member's userId in place of mediaId.
  • To add tags to groups, set mediaType to group and use the group’s groupId in place of mediaId.

Contents

Parameters

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

  • mediaType. The media type. audio, photo, blog, video, sets, comment or emedia.
  • mediaId/userId/groupId. The id of the media or the member or the group to which the tag(s) will be added. For external media, this value can be anything, but it must be included (it is nonfunctional).
  • as. The site that you are searching. Each affiliate site has a unique as.

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".
  • url. Required for external media only (do not include in other calls). The url of the external media (same as pathToMedia).
  • tags. Required. The tag or tags to add. Each tag can include multiple words but must not be longer than 20 characters, not including the commas that separate each tag. Use URL-encoded space characters (%20) to create spaces between words.

JSON Payload

On success, a payload that begins with "status":"1","error":"". If tags were added, the payload includes a list of added tags.

Note: if a single tag fails validation, any other tags in the call that passed validation are still uploaded.


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.

Parameters

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

  • mediaType. The media type. audio, photo, blog, video, or emedia.
  • mediaId/userId/groupId. The id of the media or the member or the group to which the tag(s) will be added. For external media, this value can be anything, but it must be included (it is nonfunctional).
  • as. The site that you are searching. Each affiliate site has a unique as.

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".
  • url. Required for external media only (do not include in other calls). The url of the external media (same as pathToMedia).
  • tags. Required. The tag or tags to add. Each tag can include multiple words but must not be longer than 20 characters, not including the commas that separate each tag. Use URL-encoded space characters (%20) to create spaces between words.

JSON Payload

On success, a payload that begins with "status":"1","error":"". If tags were added, the payload includes a list of added tags.

Note: if a single tag fails validation, any other tags in the call that passed validation are still uploaded.


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/Add_Tags_To_Media,_Members_and_Groups"