API:v1r1:main
From MixxHelp
Contents |
Mixx API
Overview
Mixx provides a publicly accessible API that allows external developers to produce applications which make use of data and functionality provided by the Mixx web application. The API is made up of a set of controllers, each of which encapsulates specific actions that may be called to retrieve data, or to submit data to the system. The API is accessible via HTTP, and returns data in XML.
Getting Started
- Obtaining and Configuring an API Key
- Testing Your API Key
- User Authentication
- Output Formats
- API Versioning
- Lost? Get Help via Email
Controllers
Controllers are where all the magic happens. They are what take your requests and return results. Each controller provides functionality pertaining to a specific subset of the API, be it retrieving story, video, or photo information, adding a comment to an item, or even just testing your requests without taking any real action. All controllers require, at a minimum, that you provide your API key as the 'api_key' parameter in the URL you call. Most controllers have additional minimum requirements and optional parameters that are documented on their individual pages.
