API Documentation
The Vlog Comment Generator has an open API allowing any developer to create tools based around the generator. This service is provided free of charge.
The following methods are exposed. All requests are HTP GET requests and all replies are JSON objects. All requests should be made to the URL http://comments.videoblogging.info/api/?method=[name] where [name] is the name of the method you wish to invoke. Some method take additional parameters. These should be attached as regular GET paramaters.
getTotal
Returns the total amount of comments generated. This method has no parameters.
Return value
A JSON object. The 'totalCount' property contains the count.
Sample request
getComment
Generates a comment and returns it. This method has 3 optional parameters:
- type
- The type of comment you want. Accepted values: 'encouragement', 'inspirational', 'technical', 'criticism', 'a surprise'. Leave blank for a surprise.
- thankyou
- Boolean integer. 0 if you do not want a thank you added. 1 if you do.
- smiley
- Boolean integer. 0 if you do not want a smiley added. 1 if you do.
Return value
A comment object will be returned. It has the following properties.
- text
- The comment text.
- type
- The type of comment generated. Possible values: 'encouragement', 'inspirational', 'technical', 'criticism', 'a surprise'.
- thankyou
- Boolean integer. 0 if a thank you was not added. 1 if it was.
- smiley
- Boolean integer. 0 if a smiley was not added. 1 if it was.
Sample request
getLatestComments
Returns the list of the last generated comments. It takes one optional parameter:
- length
- The length of the list to be generated. An integer between 1 and 30.
Return value
An array of comment objects. Each object has the following properties:
- text
- The comment text.
- timestamp
- Unix timestamp describing when the comment was generated.
- thankyou
- Boolean integer. 0 if a thank you was not added. 1 if it was.
- smiley
- Boolean integer. 0 if a smiley was not added. 1 if it was.
