API Services and Developers Kit

From KickApps API Reference

Jump to: navigation, search

KickApps APIs (Application Programming Interfaces) provide you direct “code-level” access to all KickApps-powered features and community data, giving you complete control over your page designs and powerful options for integrating your KickApps-powered community with other websites and services.

The APIs are a supplemental feature, augmenting the core KickApps hosted platform of hosted pages, feeds, and widgets.

Contents

Your API Deployment Options

Depending on your technical resources, you can use both the KickApps Developer’s Kit as well as our professional services team. The Developers Kit enables you to access our most commonly used functionality through REST and SOAP APIs. It includes reference documentation, sample applications, and support. The summary tables on the next page show the available calls and functionality.

If you choose to use KickApps' professional services team to build a custom API-based implementation, we’ll map your requirements to the best and most efficient solutions for you, such as where to use hosted pages, Widgets, feeds, and API calls. To get started, you should have clear, detailed requirements (preferably including wireframes and use cases) so we can create pricing estimates and timelines.

What You’ll Need

To use the KickApps APIs you'll need:

  • A KickApps affiliate account
  • An API usage contract
  • A server that is set up to call KickApps' servers.
  • A technical team that is comfortable with a dynamic server language or a contract with our professional

services team

For information about pricing and support options, contact KickApps at APIinfo@kickapps.com.

What KickApps Provides

Once you have a contract, we’ll provide:

  • An API developer’s key
  • Documented instructions on how to call the APIs
  • Sample application code in PHP
  • Technical support
  • Custom development work from our professional services team (optional)

Every API-based deployment is managed by a KickApps account lead. We’ll work closely with you to quickly answer questions and fulfill requests.

REST API Calls in the Developers Kit

  • Create Token: Create a token that contains access permissions to call the APIs.
  • Retrieve Media Resource: Retrieve a specific media file (photo image, movie, or audio track).
  • Retrieve Play Page: Retrieve a full media play page.
  • Retrieve External Media: Retrieve data associated with an external media object.
  • Search: Pass search parameters and display results. Searches are available for all media, comments, members, and message board posts.
  • Upload Media: Add audio, video, and photo files to the KickApps servers. Enables integration with a Content Delivery Network (CDN).
  • Add Blog Post: Add a blog post to the KickApps database.
  • Edit Blog Post: Edit a blog post within the KickApps database.
  • Add External Media: Add a listing for an external page (such as an article on your own website) to the KickApps database. (Allows KickApps-powered comments and ratings to be added to your own site pages.)
  • Email Media: Email an invitation to view media.
  • Add or Remove Media Flag: Flag a media item as inappropriate for the community.
  • Add/Remove from Favorites: Add or remove a media item from the user's favorites.
  • Retrieve Member Profile: Retrieve a member's profile.
  • Get Member’s Friends & Fans: Retrieve lists of members’ friends, fans, and those the member is a fan of.
  • Add Admin Tags to Media, Members, & Groups: Add admin tags to a media item, member, or group.
  • Add Media Rating: Add a rating to a media item (audio, blog, video, and photo).
  • Retrieve Media Ratings: Retrieve all ratings for a media item.
  • Add Comment: Add a comment to a media item (audio, blog, photo, video), member, or group.
  • Retrieve Comments: Retrieve comments from media and members.
  • Edit Comment: Edit an existing media, member, or group comment.
  • Flag Comment: Flag a media, member, or group comment as inappropriate for the community.
  • Add Group: Add a new group to the community.
  • Edit Group: Edit a group’s name, tags, description, and category.
  • Request a Group: Allow members to request new groups.
  • Retrieve Group Page: Retrieve a full group page’s content.
  • Add/Remove Group Member: Add or remove an existing member to a group.
  • Add/Remove Group Media: Add or remove videos, photos, audio tracks, and blogs to a group.
  • Upload Group Photo: Add a photo to serve as a group’s logo.
  • Edit Group Photo: Edit a group’s photo logo.

Single Sign-On SOAP API Calls in Developers Kit

  • Register Member: Register member.
  • Sign In Member: Sign in member.
  • Register and Sign in Member: With this call you can sign in an existing member, without needing a separate step to import the member's registration information.
  • Sign Out Member: Sign out a member.
  • Member Change Username: Changes the username for a member.
  • Member Change Email: Changes the email for a member.
  • Member Profile Edit/Update: Make changes to an existing member's profile.

APIs & the Hosted Service

KickApps APIs enable you to make real-time requests to receive, update, and delete information. Information is returned in a single, standardized format that you can display, process, and store.

You can access the APIs to:

  • Modify workflows. Customize registration processes and other user workflows.
  • Customize Display. Return specific data and have full control over how the data is displayed—beyond the flexibility provided by a typical CSS.
  • Customize Media. Rather than use KickApps' standard media types (audio, video, photo, user and blog), you can create your own media types and sync these with KickApps. We will then add and update all related data for that media (such as comments and ratings).
  • Extend Your CMS. Supplement your existing CMS with content and data from KickApps.

Security

In addition to protecting your website from inappropriate content via the media management, reporting and administrative tools in the KickApps Affiliate Center, we secure your community information by:

  • Controlling user logins via SSO and session tokens.
  • Tracking the developers accessing your server and requiring a valid session token to modify information.
  • Providing server-to-server communications so data isn’t seen by third parties.

FAQs

Q: What setup do I need to use the APIs?
A: You’ll need a web application server set up to call our servers.

Q: Are all features offered through API calls?
A: Yes. If you would like a feature that is not exposed by the Developers Kit, contact KickApps and we will be happy to provide custom API calls.

Q: Can I host the KickApps platform myself?
A: No. To use the KickApps platform, KickApps needs to be the host. If you are calling Kick Apps' APIs you'll host the code to call KickApps servers.

About KickApps

KickApps provides on-demand social media applications, enabling web publishers and marketers to quickly and easily grow, engage, and monetize their online audiences.

KickApps' customers include: ABC Family, Kraft Foods, Procter & Gamble, HBO, Cinemax, National Public Radio, The CW Television Network, Scripps Networks Interactive, Cox Television, Guinness World Records, the Seattle Seahawks, the Phoenix Suns, VIBE Magazine, and others.

For more information, please visit http://www.kickapps.com.

Retrieved from "http://www.kickdeveloper.com/api/index.php/API_Services_and_Developers_Kit"