Add Admin Tags To Media, Members and Groups

From KickApps Documentation

Jump to: navigation, search

Contents

Overview

The webmaster account can add admin-only tags to media and members. To do this, you must be logged in as the webmaster. You can make an HTTP POST or GET request when using this call. Unlike normal tags, admin tags support thousands of characters, effectively allowing you to add unlimited metadata to any member or media object.

Your request will look something like the following for media:

http://api.kickapps.com/rest/admintags/add/{mediaType)/{mediaId}/{as}

For groups, your request will look like this:

http://api.kickapps.com/rest/admintags/add/group/{groupId}/{as}

And for members, your request will look like this:

http://api.kickapps.com/rest/admintags/add/user/{userId}/{as}

Note that the URIs are slightly different: “admintags” for media and groups versus “admintag” for members; and for groups you will also need to include the additional “add/group/” before the groupId.

You can also Remove Admin Tags From Media, Members and Groups using very similar syntax.

Parameters

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

  • mediaType. The media type. audio, photo, blog, video, sets or emedia.
  • mediaId/userId. The id of the media or the member 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 will looks like as follow:

{"payload_type":"json","status":"1","error":"",
"admintags":["big bang"]}
  • admintags. List of admin tags that has been added for this media

Permissions

Overview

KIT Cloud Social API call that lets you post activities done outside the community into the community activity feeds for members.

Your request will look something like the following:

http://api.kickapps.com/rest/kickconnect/{memberId}/{as} 

Parameters

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

  • memberId. The id of the user for who the update is being made.
  • as. The site Id 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".
  • storyContent. Required. Accepts HTML and text. Allows 5,000 characters. Be sure to urlEncode the string that you pass for this variable.
  • storyIcon. Optional. url of the image to be associated with the story. Recommended size is 16 X 16.
  • postedFromSource. Optional. This is the name of the service from which the activity is being posted from. Allows 200 characters.
  • postToGroups. Optional. Should accept comma separated groupID's. Should only post to a group if the user is a member of that group.

JSON Payload

  • On success, the call will return "status":"1","message":"Story published successfully."
  • On failure, the call will return "status":"-1","message":"Story could not be published. Please make sure that the provided information is accurate."
  • If the user doesn't belong to the group(s) return, "status":"-1","message":"Story could not be published. Please make sure that the member belongs to the group(s)."

Permissions

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.