From KickApps API Reference

You can use the REST (REpresentational State Transfer) API, to request resources on the KickApps' platform (such as media files and member comments) and use and display them to suit your exact needs, using technologies such as J2EE, .NET, and PHP.

KickApps will regularly add new REST API Calls, documentation, and code samples. You are welcome to use the sample apps as the means to build your own applications.

Contents 1 Information for Reviewers 2 APIs and the Hosted Platform 3 Should you read this? 4 Let us know what you think 5 List of KickApps API Calls

Information for Reviewers

If you're reviewing this guide or are new to API development, the following sections will be especially useful. If you need API access data or features not currently exposed by the REST or SOAP API calls, contact KickApps for more information.

• Getting Started. Familiarizing yourself with the KickApps APIs.
• REST API. Describes each "call" developers can make to the KickApps servers. From each description, you can link to the call's details.
• Change Log. Stay abreast with the ever evolving KickApps APIs. Here you can track new calls, bug fixes and documentation updates for the KickApps APIs.
• Glossary. Definition of commonly used terms in this documentation.
• REST API Sample Applications. Take a look at how these API references look while in action.

APIs and the Hosted Platform

KickApps APIs closely mirror the functionality of our hosted service. In addition to the developer kit, our in-house development team can be contracted to build API-driven communities and also deliver custom APIs that are not currently available through the developer kit.

When using the APIs, you can also use any of the functionality available through our hosted platform, which is best suited for launching new communities, web forms, and transaction-heavy pages. We expect that most affiliates will use the hosted service, and access the APIs to modify workflows, customize member interface displays and media, and expand your CMS. KickApps will provide guidance on the best use of the APIs for your specific development needs.

Should you read this?

This wiki is for web developers. We assume you have:

• Some familiarity with the KickApps platform
• Access to a web server with a dynamic language such as Java, PHP, or .NET
• An understanding of REST web services

Not a programmer? Don’t worry; nearly all of the features described in this document are also available within the hosted KickApps platform, which doesn’t require any special coding skills. For an overview of our services you can read all about how it works and read frequently asked questions. You can also see examples of sites that are powered by KickApps.

Let us know what you think

Your feedback will help us deliver a better product back to you. We welcome and encourage questions and feedback.

Thanks,
The KickApps API Team
apiinfo@kickapps.com

List of KickApps API Calls

Create Token Social Networking Retrieve Member Profile ( Updated!) Add Or Remove Member As Friend Get A Member's Friends, Fans, and "Fan Of" KickConnect Media Sharing Upload Media Retrieve Media Meta Data Edit Media Meta Data Retrieve Play Page Retrieve Member Media Retrieve Member's Favorite Media Member Favorite Media Check Email Media Add Or Remove Media Flag Add To Or Remove From Favorites Geographic Values for Media Uploads Blogging Add Blog Post Edit Blog Post Comments and Rating Add External Media Retrieve External Media Edit External Media Add Group Comment Add Media Comment Add Profile Comment Retrieve Comments Edit Comment Edit Group Comment Delete Comment Delete Group Comment Flag Comment Flag Group Comment Rate Media Retrieve Media Ratings Retrieve Media Rated By Member Search Search

Groups Add Group Retrieve Group Page Edit Group Request A Group Add/Remove Media To Group Add/Remove Member To Group Retrieve Member Groups Upload Group Photo Remove Group Photo Media Sets (Private Beta) Add Media Set Points and Levels Add to Member Offset Retrieve Member Points Set Member Custom Level Set Member Offset Categories and Tags Add Tags To Media, Members and Groups Add Admin Tags To Media, Members and Groups Remove Admin Tags From Media, Members and Groups Retrieve Admin Tags Retrieve Tag Count Add Category Edit Category Retrieve Category Delete Category Add Custom Meta Data Remove Custom Meta Data Retrieve Custom Meta Data Member and Media Management Approve Member Reject Member Approve Member Media Reject Member Media Retrieve Pending Media Retrieve Active Member Count

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.

This page was last modified on 3 November 2009, at 17:24. - This page has been accessed 2,910 times. -

About KickApps API Reference