API 0.1.5

Extensible RESTful API shim that operates in JSON or XML. Supports JSONP and CORS

 

Notice: This application is not related to the Simple API extension available to hosted Vanilla Forums customers.

GitHub version

Getting started

To get started using Vanilla API, either:

  • Download the latest release
  • Clone the repository directly into your Vanilla applications directory:
    $ git clone kasperisager/vanilla-api api

How it works

Vanilla API is a shim that implements a RESTful URI scheme upon with you can invoke different methods using the standard GET, POST, PUT and DELETE HTTP verbs. The API then translates and redirects your request to the corresponding application controller which in return caries out the requested method.

Configuration

The API can be configured through the dashboard using the "Application Interface" menu found in the "Forums Settings" section. Here you can see the main API endpoint and you can re-generate the application secret used for signature based authentication.
Read more about configuration

Authentication

Vanilla API supports two different authentication methods: A semi-stateless session based method as well as a stateless signature based method. The former is best used when doing client <-> server communication whereas the latter is good for server <-> server communication.
Read more about authentication

Extending

Vanilla API allows you to easily integrate your own plugins and applications with the API Mapper - it's as simple as creating a new API class and putting it anywhere in your application or plugin where the Garden autoloader can find it.
Read more about extending the API

Issue tracking

If you come across any bugs or if you have a feature request, please file an issue using the GitHub Issue tracker. Vanilla API won't be supported through http://vanillaforums.org so please stick to using GitHub for inquiries about bugs and feature requests. Thanks!
File a new issue or feature request

GitHub: https://github.com/kasperisager/vanilla-api


Copyright © 2013-2015 Kasper Kronborg Isager. Licensed under the terms of the MIT License.

Questions