This repository has been archived by the owner. It is now read-only.
Extensible RESTful API shim for Vanilla that operates in JSON or XML with support for JSONP and CORS
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
controllers
library
locale
settings
views/settings
.editorconfig
LICENSE.md
README.md
composer.json
composer.lock
icon.png
icon.svg

README.md

Vanilla API

Vanilla API

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

Getting started

To get started using Vanilla API, either:

$ git clone https://github.com/kasperisager/vanilla-api.git api

When you've done this, make sure the newly created folder is named api and not vanilla-api. Now simply go to your dashboard, enable Vanilla API in the "Applications" menu and you're all set!

How does it work?

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.

Documentation

You can find documentation on how to use, configure and extend Vanilla API in the Wiki.

License

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