![]() |
The FORUMS libre web API |
In addition to being able to embed your forum on your own website, and access them from any Android device, you can also access your forums through the FORUMS libre web API. The web API gives you the advantage of having complete control of your forum's client interface. You can use the web API to access your forum from your own website through JavaScript, PHP or any other language. You can also use the web API to create your own mobile application to access your forum, such as an Android or iOS application. A web API, is a set of HTTP GET/POST URI's that allow sending and receiving of message data. When you browse a website, your browser makes a series of HTTP GET/POST requests to URIs that return HTML content. In a web service the URIs return XML or JSON data, instead of HTML content. The FORUMS libre web API provides a REST API with XML message content. The API's take HTTP POST XML data, and return XML data.
HTTP XML POST API
create-userThe create-user API creates a new user, and returns the user's details.
URI: http://www.forumslibre.com/rest/forumslibre/create-user
XML POST Example
check-userThe check-user API validates a user, and returns the user's details.
URI: http://www.forumslibre.com/rest/forumslibre/form-check-user
Parameters
XML POST Example
get-forumsThe get-forums API queries the details for all forums matching the criteria.
URI: http://www.forumslibre.com/rest/forumslibre/get-forums
XML POST Example
get-forum-postsThe get-forum-posts API queries the details for all forum posts matching the criteria.
URI: http://www.forumslibre.com/rest/forumslibre/get-forum-posts
XML POST Example
check-forumThe check-forum API validates that a forum ID or name exists, and returns the forum's details.
URI: http://www.forumslibre.com/rest/forumslibre/check-forum
Parameters
XML POST Example
check-forum-postThe check-forum-post API validates that a forum post ID exists, and returns the forum post's details.
URI: http://www.forumslibre.com/rest/forumslibre/check-forum-post
XML POST Example
create-forum-postThe create-forum-post API creates a new forum post, the post details with its ID is returned. You must pass the ID of the forum posting to.
URI: http://www.forumslibre.com/rest/forumslibre/create-forum-post
XML POST Example
create-replyThe create-reply API creates a new forum reply, the reply details with its ID is returned. You must pass the ID of the forum post replying to.
URI: http://www.forumslibre.com/rest/forumslibre/create-reply
XML POST Example
update-forum-postThe update-forum-post API updates a existing forum post, the post details with its ID is returned. You must pass the ID of the forum post you are updating.
URI: http://www.forumslibre.com/rest/forumslibre/update-forum-post
XML POST ExampleSo, that is the basic web API. You can now build your own interface for your forum. You can use the API on your own website, or in your own mobile application. For a complete Java code example of using the full API, refer to the SDK source code on Project Libre on GitHub. |
|||||||||||||||||||||
|
|||||||||||||||||||||
|