Plancast API

Type of Data Avaialble

User data: Get user profile info, sign in to Plancast, subscribe and unsubscribe to other users (similar to follow/unfollow).

Place data: Retrieve place information by the keywords you input

Plan data: Get information around plans on Plancast

Multimedia: Retrieve multimedia, comment, and watch

All data avaialble from this API is provided from Plancast.

 

Request Limits

 Plancast API Key  APPLY FOR A KEY

·       Active - Upon registration

·       Throttle Rate - 2 calls per second

·       Quota Limit – 10,000 calls per day

 

Software developers can use our application programming interface (API) to build applications that exchange data with Plancast programmatically.

The following documentation describes how to interface RESTfully with our API. It returns data in JSON format. For those interested in alternative formats, we've also made RSS and iCal feeds available across the site, such as on user profile and category pages.

To use Plancast API, please create a developer account and register for an API Key.

If you have any questions, suggestions or corrections, please write to us at PlancastSupport@activenetwork.com.

Authentication

The API currently supports only basic access authentication and not other protocols such as oAuth (sorry). Authentication requires a particular user's username and password, which must be set beforehand even if the user originally joined Plancast by authenticating with their Facebook or Twitter account.

Rate Limits

There are no explicit rate limits placed on API usage, nor do we assign API keys. However, we do monitor usage and will intervene when service performance suffers due to an unreasonable number of requests.

Libraries

Wynn Netherland has created a Ruby wrapper and Bartek Ciszkowski has created a Python wrapper you can use. If you've created a library of your own for the Plancast API that you'd be willing to share, please let us know.

JSONP

JSONP can be attained for most methods by passing your desired callback function name as the value for the "jsonp" parameter (for example, http://api.plancast.com/02/users/search.json?q=mark&jsonp=myCallback).

Times & Time Zones

Plancast handles times and time zones for plans by storing all timestamps in UTC. This effectively means that Plancast treats a plan taking place in California at 6pm as occurring at the same time as a plan taking place at 6pm in New York or France.

If your application adjusts timestamps based on time zone offsets, you may need to recalculate the timestamp you get from, or post to, us.

Methods

Method Description
user/signin API for user to sign in plancast with username/email and password
user/subscribe API for user to subscribe someone they are interested in
user/removeSubscribe API for user to unsubscribe someone they subscribed
user/show API for showing user's detailed information
place/guess API for getting place information by the keywords you input
plan/search API for searching plan by plan's title using keywords, display 10 results of searching start from the page you go
plan/listing API for listing plans by conditions
plan/attend API for attending a plan
plan/unattend API for unattending a plan
plan/tracking API for tracking a plan
plan/untracking API for untracking a plan
plan/show API for watching plan's detail
plan/participants API for showing plan's all participants
plan/add API for adding plan
plan/parsewhen API for formating plan's time from String to Timestamp
plan/plansAttendNumber API for getting the number of attended plans of current user
plan/plansByUserTypeCategories API for getting plans of user by type and category
plan/uploadPhoto API for uploading image
plan/uploadVideo API for uploading video
plan/addComment API for adding comments to a plan
plan/comments API for getting comments of a plan
plan/cancel API for canceling a plan
multimedia/list API for listing multimedia in conditions
multimedia/addComment API for adding comments to a multimedia
multimedia/comments API for getting comments from a multimedia
multimedia/show API for watching a multimedia

user/signin

UrlAddress: http://api.amp.active.com/v3/user/signin.json

RequestType: POST

Parameters:

Name Optional Description
api_key F apply api_key provided by Developer.active.com
appId T an appId provided by Plancast.com
appTokens T appTokens MD5 from appId and appSecret which is provided by Plancast.com
username F your Plancast username or email
password F your Plancast Password for the username you input

user/subscribe

UrlAddress: http://api.amp.active.com/v3/user/subscribe.json

RequestType: POST

Parameters:

Name Optional Description
api_key F apply api_key provided by Developer.active.com
appId T an appId provided by Plancast.com
appTokens T appTokens MD5 from appId and appSecret which is provided by Plancast.com
sessiontoken F session token of current plancast user
user_id F id of the user whom you want to subscribe

user/removeSubscribe

UrlAddress: http://api.amp.active.com/v3/user/removeSubscribe.json

RequestType: POST

Parameters:

Name Optional Description
api_key F apply api_key provided by Developer.active.com
appId T an appId provided by Plancast.com
appTokens T appTokens MD5 from appId and appSecret which is provided by Plancast.com
sessiontoken F session token of current plancast user
user_id F id of the user whom you want to unsubscribe

user/show

UrlAddress: http://api.amp.active.com/v3/user/show.json

RequestType: POST

Parameters:

Name Optional Description
api_key F apply api_key provided by Developer.active.com
appId T an appId provided by Plancast.com
appTokens T appTokens MD5 from appId and appSecret which is provided by Plancast.com
user_id F id of the user who will show his detailed information
sessiontoken T session token of current plancast user

place/guess

UrlAddress: http://api.amp.active.com/v3/place/guess.json

RequestType: POST

Parameters:

Name Optional Description
api_key F apply api_key provided by Developer.active.com
appId T an appId provided by Plancast.com
appTokens T appTokens MD5 from appId and appSecret which is provided by Plancast.com
keyword T keywords that you input for querying place information

plan/search

UrlAddress: http://api.amp.active.com/v3/plan/search.json

RequestType: POST

Parameters:

Name Optional Default value Description
api_key F apply api_key provided by Developer.active.com
appId T an appId provided by Plancast.com
appTokens T appTokens MD5 from appId and appSecret which is provided by Plancast.com
keyword F keywords that you input for querying place information
limit T 10 the limitation of results
page T 1 the start page of user's querying

plan/listing

UrlAddress: http://api.amp.active.com/v3/plan/listing.json

RequestType: POST

Parameters:

Name Optional Default value Description
api_key F apply api_key provided by Developer.active.com
appId T an appId provided by Plancast.com
appTokens T appTokens MD5 from appId and appSecret which is provided by Plancast.com
listType F list type of listing action that will leads the response formating, values:{'public', 'friends'}
sessiontoken F if listType is 'friends', else T session token of current plancast user
order_field T when_start order type for plan listing, parameter's value will be chose within these two options: 'when_start' and 'popularity'
categories T primary and secondary category for plan querying, separated by ',', like 'Music,Sports'
lat T latitude for creating temporary place map
lon T longitude for creating temporary place map

plan/attend

UrlAddress:  http://api.amp.active.com/v3/plan/attend.json

RequestType: POST

Parameters:

Name Optional Description
api_key F apply api_key provided by Developer.active.com
appId T an appId provided by Plancast.com
appTokens T appTokens MD5 from appId and appSecret which is provided by Plancast.com
sessiontoken F session token of current plancast user
plan_id F id of the plan which you want to attend

plan/unattend

UrlAddress:  http://api.amp.active.com/v3/plan/unattend.json

RequestType: POST

Parameters:

Name Optional Description
api_key F apply api_key provided by Developer.active.com
appId T an appId provided by Plancast.com
appTokens T appTokens MD5 from appId and appSecret which is provided by Plancast.com
sessiontoken F session token of current plancast user
plan_id F id of the plan which you want to unattend

plan/tracking

UrlAddress:  http://api.amp.active.com/v3/plan/tracking.json

RequestType:  POST

Parameters:

Name Optional Description
api_key F apply api_key provided by Developer.active.com
appId T an appId provided by Plancast.com
appTokens T appTokens MD5 from appId and appSecret which is provided by Plancast.com
sessiontoken F session token of current plancast user
plan_id F id of the plan which you want to track

plan/untracking

UrlAddress:  http://api.amp.active.com/v3/plan/untracking.json

RequestType:  POST

Parameters:

Name Optional Description
api_key F apply api_key provided by Developer.active.com
appId T an appId provided by Plancast.com
appTokens T appTokens MD5 from appId and appSecret which is provided by Plancast.com
sessiontoken F session token of current plancast user
plan_id F id of the plan which you want to untrack

plan/show

UrlAddress:  http://api.amp.active.com/v3/plan/show.json

RequestType: POST

Parameters:

Name Optional Description
api_key F apply api_key provided by Developer.active.com
appId T an appId provided by Plancast.com
appTokens T appTokens MD5 from appId and appSecret which is provided by Plancast.com
plan_id F id of the plan which you want to see
sessiontoken T session token of current plancast user

plan/participants

UrlAddress:  http://api.amp.active.com/v3/plan/participants.json

RequestType:  POST

Parameters:

Name Optional Description
api_key F apply api_key provided by Developer.active.com
appId T an appId provided by Plancast.com
appTokens T appTokens MD5 from appId and appSecret which is provided by Plancast.com
plan_id F id of the plan whose participants you want to see

plan/add

UrlAddress: http://api.amp.active.com/v3/plan/add.json

RequestType:  POST

Parameters:

Name Optional Default value Description
api_key F apply api_key provided by Developer.active.com
appId T an appId provided by Plancast.com
appTokens T appTokens MD5 from appId and appSecret which is provided by Plancast.com
sessiontoken F session token of current plancast user
what_string F name of plan that user want to create
when_string F time of plan that user want to create
where_string F address of plan that user want to create
when_start T parameter from parsewhen API(if you do not provide 'when_start' and 'when_stop', the time of event you create will be based on the 'when_string' you input; if you provide, the time of event will be formated from these timestamps)
when_stop T parameter from parsewhen API(if you do not provide 'when_start' and 'when_stop', the time of event you create will be based on the 'when_string' you input; if you provide, the time of event will be formated from these timestamps)
organize_type T 2 role of user in the plan he created(1:organizer 2:participant)
approveShowUpload T false choice of plan owner that multimedias' uploading in his plan need approval to display or not
timezone_offset T 0 timezone offset of plan that user want to create
description T plan description
banner_url T url of plan's logo
external_url T url of plan that user want to create
category1 T primary category of plan that user want to create
category2 T secondary category of plan that user want to create
place_id T place id given by owner using google address service
to_facebook T choice of plan owner that sending message to facebook for this action or not
to_twitter T choice of plan owner that sending message to twitter for this action or not

plan/parsewhen

UrlAddress: http://api.amp.active.com/v3/plan/parsewhen.json

RequestType: POST

Parameters:

Name Optional Description
api_key F apply api_key provided by Developer.active.com
appId T an appId provided by Plancast.com
appTokens T appTokens MD5 from appId and appSecret which is provided by Plancast.com
sessiontoken F session token of current plancast user
when F when string that you want to format

plan/plansAttendNumber

UrlAddress: http://api.amp.active.com/v3/plan/plansAttendNumber.json

RequestType: POST

Parameters:

Name Optional Description
api_key F apply api_key provided by Developer.active.com
appId T an appId provided by Plancast.com
appTokens T appTokens MD5 from appId and appSecret which is provided by Plancast.com
sessiontoken F session token of current plancast user

plan/plansByUserTypeCategories

UrlAddress:  http://api.amp.active.com/v3/plan/plansByUserTypeCategories.json

RequestType: POST

Parameters:

Name Optional Description
api_key F apply api_key provided by Developer.active.com
appId T an appId provided by Plancast.com
appTokens T appTokens MD5 from appId and appSecret which is provided by Plancast.com
usertype F user's role in a plan which is related to him, value should be in array{'organizing','attending'} if he wants to see others plans, and can be in array{'organizing','attending','invited','tracking'} if he is about to see his profile
sessiontoken T(sessiontoken and user_id must be provided at least one) session token of current plancast user
user_id T(sessiontoken and user_id must be provided at least one) id of user whose plans you want to see(if this area is not provided, you will see plans in your profile by default if 'sessiontoken' is provided)

plan/uploadPhoto

UrlAddress:  http://api.amp.active.com/v3/plan/uploadPhoto.json

RequestType: POST

Parameters:

Name Optional Description
api_key F apply api_key provided by Developer.active.com
appId T an appId provided by Plancast.com
appTokens T appTokens MD5 from appId and appSecret which is provided by Plancast.com
sessiontoken F session token of current plancast user
PlanMultimedia F an object that contains user's upload parameters(plan_id for plan, and multimedia for image stream)
share T optional value of user's option, if value is '1', will send value of paramter 'message'
message T message that will send in the notification email if 'share' parameter's value is '1'

plan/uploadVideo

UrlAddress:   http://api.amp.active.com/v3/plan/uploadVideo.json

RequestType:  POST

Parameters:

Name Optional Description
api_key F apply api_key provided by Developer.active.com
appId T an appId provided by Plancast.com
appTokens T appTokens MD5 from appId and appSecret which is provided by Plancast.com
sessiontoken F session token of current plancast user
PlanMultimedia F an object that contains user's upload parameters(plan_id for plan, and multimedia for video stream)
share T optional value of user's option, if value is '1', will send value of paramter 'message'
message T message that will send in the notification email if 'share' parameter's value is '1'

plan/addComment

UrlAddress:  http://api.amp.active.com/v3/plan/addComment.json

RequestType:  POST

Parameters:

Name Optional Description
api_key F apply api_key provided by Developer.active.com
appId T an appId provided by Plancast.com
appTokens T appTokens MD5 from appId and appSecret which is provided by Plancast.com
sessiontoken F session token of current plancast user
content F comment of user's input for a plan
id F id of plan which user wants to add comment to

plan/comments

UrlAddress:   http://api.amp.active.com/v3/plan/comments.json

RequestType: POST

Parameters:

Name Optional Description
api_key F apply api_key provided by Developer.active.com
appId T an appId provided by Plancast.com
appTokens T appTokens MD5 from appId and appSecret which is provided by Plancast.com
id F id of plan from which user wants to get comments

plan/cancel

UrlAddress:  http://api.amp.active.com/v3/plan/cancel.json

RequestType:  POST

Parameters:

Name Optional Description
api_key F apply api_key provided by Developer.active.com
appId T an appId provided by Plancast.com
appTokens T appTokens MD5 from appId and appSecret which is provided by Plancast.com
sessiontoken F session token of current plancast user
plan_id F id of plan which you want to cancel

multimedia/list

UrlAddress: http://api.amp.active.com/v3/multimedia/list.json

RequestType:  POST

Parameters:

Name Optional Default value Description
api_key F apply api_key provided by Developer.active.com
appId T an appId provided by Plancast.com
appTokens T appTokens MD5 from appId and appSecret which is provided by Plancast.com
sessiontoken T session token of current plancast user
categories T primary and secondary category for plan multimedia, separated by ',', like 'Music,Sports'
order_field T when_start order type for multimedia listing, parameter's value will be chose within these two options: 'when_start' and 'popularity'
lat T latitude for creating temporary place map
lon T longitude for creating temporary place map

multimedia/addComment

UrlAddress:  http://api.amp.active.com/v3/multimedia/addComment.json

RequestType:  POST

Parameters:

Name Optional Description
api_key F apply api_key provided by Developer.active.com
appId T an appId provided by Plancast.com
appTokens T appTokens MD5 from appId and appSecret which is provided by Plancast.com
sessiontoken F session token of current plancast user
content F comment of user's input for a multemedia
id F id of multimedia which user wants to add comment to

multimedia/comments

UrlAddress: http://api.amp.active.com/v3/multimedia/comments.json

RequestType:  POST

Parameters:

Name Optional Description
api_key F apply api_key provided by Developer.active.com
appId T an appId provided by Plancast.com
appTokens T appTokens MD5 from appId and appSecret which is provided by Plancast.com
id F id of multimedia from which user wants to get comments

multimedia/show

UrlAddress:  http://api.amp.active.com/v3/multimedia/show.json

RequestType: POST

Parameters:

Name Optional Description
api_key F apply api_key provided by Developer.active.com
appId T an appId provided by Plancast.com
appTokens T appTokens MD5 from appId and appSecret which is provided by Plancast.com
id F id of multemedia which user wants to see
sessiontoken T session token of current plancast user

Demos

Demo 1.1 PHP/JAVA call 'user/signin' API

PHP 
 1 <?php
 2     //Call user/signin API with PHP code
 3     $url = 'http://api.amp.active.com/v3/user/signin.json';
 4     $api_key = Apply api_key provided by Developer.active.com;
 5     $username = Your username of Plancast;
 6     $password = The password for your username;
 7     $data = array(
 8         'api_key' => $api_key,
 9         'username' => $username,
10         'password' => $password
11     );
12     $post_data = array(
13         CURLOPT_POST => true,
14         CURLOPT_HEADER => 0,
15         CURLOPT_URL => $url,
16         CURLOPT_POSTFIELDS => http_build_query($data)
17     );
18 
19     $ch = curl_init();
20     curl_setopt_array($ch, ($post_data));
21     print_r(curl_exec($ch));
22  ?>
JAVA 
 
 1 
 2     //Step1: apply the api_key provided by Developer.active.com into a new String
 3     final String api_key = Apply api_key provided by Developer.active.com;
 4     //Step2: provide the parameters that is needed in your api request 
 5     final String username = Your username of Plancast;
 6     final String password = The password for your username;
 7     //Step3: use api address we provided in our API documentation
 8     String urlConnectionTestString = "http://api.amp.active.com/v3/user/signin.json";
 9     //Step4: initial parameters that is needed in your api request(in the POST request)
10     String urlConnectionParameter = "api_key="+api_key+"&username="+username+"&password="+password;
11     //Step5: POST your request to plancast and get the response
12     .
13     .
14     .

Demo 2. PHP call 'plan/attend' API

 1 <?php
 2     //Call user/signin API with PHP code
 3     $url = 'http://api.amp.active.com/v3/plan/attend.json';
 4     $api_key = Apply api_key provided by Developer.active.com;
 5     $sessiontoken = Session token of current plancast user;
 6     $planID = ID of the plan which you want to attend;
 7     $data = array(
 8         'api_key' => $api_key,
 9         'sessiontoken' => $sessiontoken,
10         'plan_id' => $planID
11     );
12     $post_data = array(
13         CURLOPT_POST => true,
14         CURLOPT_HEADER => 0,
15         CURLOPT_URL => $url,
16         CURLOPT_POSTFIELDS => http_build_query($data)
17     );
18 
19     $ch = curl_init();
20     curl_setopt_array($ch, ($post_data));
21     print_r(curl_exec($ch));
22  ?>

version 30 as of 3 months ago by jarredd

0 Comments

Please sign in to post a comment.