BetaEasy API Documentation
Callback API
The BetaEasy Callback API allows you to interact and “sync” with your BetaEasy account with your own web sites and applications.
Every time when any event happens on your BetaEasy forum (user_join, user_activated etc - see complete list below) - BetaEasy makes call to your handler, so you can process this event in your application.
See detailed specification below.
Permanent Parameters
These parameters are passed with every request from BetaEasy
- event - type of event, eg. "user_joined" or "user_leave", list of all event types can be found below
- key - api access key to check identity of requesting side, this key you can be found in Manage Project -> API Integration (section)
Methods
user_join - User Joined to Project
- email - User email
- user_id - Internal user_id, may be used to link to betaeasy users
- project_slug - project identifier, first part of public forums url like (myproject.betaeasy.com), myproject is a project slug
- project_id - internal project_id, may be used if you are using one callback url for several projects
- active - if project is private user will be inactive after joining
user_activated - User was approved by project administration
- email - User email
- user_id - Internal user_id, may be used to link to betaeasy users
- project_slug - project identifier, first part of public forums url like (myproject.betaeasy.com), myproject is a project slug
- project_id - internal project_id, may be used if you are using one callback url for several projects
user_leave - User Leaving Project
- email - User email
- user_id - Internal user_id, may be used to link to betaeasy users
- project_slug - project identifier, first part of public forums url like (myproject.betaeasy.com), myproject is a project slug
- project_id - internal project_id, may be used if you are using one callback url for several projects
user_email_confirmed - New User Joined to BetaEasy
- email - User email
- user_id - Internal user_id, may be used to link to betaeasy users
- first_name - User's first name
- last_name - User's last name
- registered_at - Date and Time of user registration in format "YYYY-MM-DD HH:MM:SS"
user_email_change - User Joined to Project
- user_id - Internal user_id, may be used to link to betaeasy users
- email - new email assigned to user
- old_mail - old email that was assigned to user
Download BetaEasy Callback API Kit
PHP
.NET
Please contact us and request this implementation.
Java
Please contact us and request this implementation.
Ruby
Please contact us and request this implementation.
Python & other
Please contact us and request this implementation.
WSDL API
WSDL API is set of functions(methods) allowing your application to interact with BetaEasy.
This API allows you to integrate BetaEasy right into your specific Desktop Application, allowing to collect feedback from your users.
You can Get List of current feedbacks, Add Users, Perform Search and do other things - see detailed list below.
WSDL URL
http://app.betaeasy.com/api/soap/v1/wsdl
SOAP URL
SOAP URL
http://app.betaeasy.com/api/soap/v1
Feedback Methods
/**
* Return the most rated features
*
* @param string apikey Project API Key
* @param integer limit Limit result set. You can obtain no more than 100 feedbacks
* @return TFeedback[] Array of found feedbacks
*/
TFeedback[] feedbackRatedFeatures(string apikey, integer limit);
/**
* Attach file to feedback
*
* @param string apikey Project API Key
* @param integer feedback_id Feedback Id TFeedback->id
* @param string name Attachment file name
* @param string description Attachment description
* @param string contents Attachment contents
* @return integer Returns 1 if file stored successfully
*/
integer feedbackAttach(string apikey, integer feedback_id, string name, string description, string contents);
/**
* Search for feedbacks
*
* @param string apikey Project API Key
* @param string type Feedback type. Accepted values feature|bug
* @param string phrase Search Phrase
* @param integer limit Limit result set. You can obtain no more than 100 feedbacks
* @return TFeedback[] Array of found feedbacks
*/
TFeedback[] feedbackSearch(string apikey, string type, string phrase, integer limit);
/**
* Return the most rated bugs
*
* @param string apikey Project API Key
* @param integer limit Limit result set. You can obtain no more than 100 feedbacks
* @return TFeedback[] Array of top rated bugs
*/
TFeedback[] feedbackRatedBugs(string apikey, integer limit);
/**
* Create new feedback
*
* @param string apikey Project API Key
* @param string type Feedback type. Accepted values feature|bug
* @param string subject Feedback subject
* @param string description Feedback details
* @param string email Sender Email
* @return TFeedback
*/
TFeedback feedbackCreate(string apikey, string type, string subject, string description, string email);
/**
* Subscribe to feedback updates
*
* @param string apikey Project API Key
* @param string email Sender Email
* @param integer feedback_id Feedback ID TFeedback->id
* @return integer
*/
integer feedbackSubscribe(string apikey, string email, integer feedback_id);
/**
* Send comments to project owner (contact form)
*
* @param string apikey Project API Key
* @param string name Sender Name
* @param string email Sender Email
* @param string message Comment message
* @return integer
*/
integer commentCreate(string apikey, string name, string email, string message);
Project Methods
User Methods
/**
* List of project users
*
* @param string apikey
* @return TUser[]
*/
TUser[] userList(string apikey);
/**
* Get user details
*
* @param string apikey
* @param string user_id
* @return TUser
*/
TUser userDetails(string apikey, integer user_id);
/**
* Create beta tester account
*
* @param string apikey Projet API Key
* @param string email User email
* @param string password User password. If not set?
* @param string first_name First Name
* @param string last_name Last Name
* @return TUser Created user
*/
string userCreate(string apikey, string email, string password, string first_name, string last_name);
/**
* Unassign user from project
*
* @param string apikey Project API key
* @param integer user_id User id
* @return integer
*/
integer userUnassign(string apikey, integer user_id);
/**
* Map local user to betaeasy user
*
* @param string apikey Proejct API Key
* @param integer user_id Betaeasy user id
* @param integer map_id Your mapping id
* @return integer
*/
integer userMap(string apikey, integer user_id, integer map_id);
Types
TFeedback
complexType TFeedback {
integer project_id; // Project ID
integer id; // Feedback ID
string subject; // Feedback Subject
string url; // Public URL to feedback
integer votes; // Votes Quantity
}
TProject
complexType TProject {
integer id; // Project ID
string public_url; // Public Forum Url
string signup_url; // Beta Sign Up URL
string name; //Project Name
string identifier; // Project Identifier
string description; // Project Description
integer votes; // Votes Quantity
}
complexType TFeedback {
integer project_id; // Project ID
integer id; // Feedback ID
string subject; // Feedback Subject
string url; // Public URL to feedback
integer votes; // Votes Quantity
}
integer project_id; // Project ID
integer id; // Feedback ID
string subject; // Feedback Subject
string url; // Public URL to feedback
integer votes; // Votes Quantity
}
TProject
complexType TProject {
integer id; // Project ID
string public_url; // Public Forum Url
string signup_url; // Beta Sign Up URL
string name; //Project Name
string identifier; // Project Identifier
string description; // Project Description
integer votes; // Votes Quantity
}
complexType TProject {
integer id; // Project ID
string public_url; // Public Forum Url
string signup_url; // Beta Sign Up URL
string name; //Project Name
string identifier; // Project Identifier
string description; // Project Description
integer votes; // Votes Quantity
}
WSDL Integration Modules and Examples
See QuickStart Guide for Desktop Applications for existing integrations