Getting Started with the Weever API
The developer resources of this wiki are divided into two parts: Server API, and Third-party R3S Feed Integrations. Both are useful if you are a developer looking to utilize the Weever Apps Server to generate mobile apps for your service. Also, the later is useful for those looking to add support for Weever to their CMS extension - such as a component for Joomla, or a plugin for WordPress.
Contents |
Weever Apps Server API
The Weever Apps API version 1 is a RESTful API, using the following URI:
http://weeverapp.com/api/v1/
Queries are made via GET or POST to this url. Generally all requests contain these variables:
| Variable | Type | Description |
|---|---|---|
app
|
string
|
Which server application is being requested. Generally ajax or json.
|
m
|
string
|
Which application method is being called. |
site_key
|
string
|
A 32-character secret key connected to one app. |
cms
|
string
|
A code pertaining to the specific CMS you are calling from. Currently 'wordpress', or 'joomla', or you may soon be able to register a namespace with us. |
version
|
string
|
The version of your CMS or CMS extension connecting via the API. Currently only used for WordPress/Joomla, but required with all requests. |
generator
|
string
|
A user-agent string for your CMS or CMS extension. |
An example call would be:
http://weeverapp.com/api/v1/?app=json&m=tab_sync&site_key=ASKj6jS921LKJSja7nR5CdXfLkaj41mx7&cms=joomla&version=1.3.1&generator=Weever+Apps+Admin+Component+for+Joomla!+1.7
Getting API Site Keys
You can generate a site key by signing up for a free app or subscribing to one of our plans. As our system is platform-agnostic, feature access is controlled at the API key level; those who build with WordPress have theoretically the same access to features as those in Joomla, as would those using the API to build an app with.
Be aware, however, that we reserve the right to limit the number of free apps per developer. For those seeking to generate new apps "on the fly", please inquire about our developer partnership program.
Server API Documentation
There are two main applications used app building and management. These are: json, primarily used for requesting information about a mobile app (getter methods), and ajax, primarily used for making alterations to a mobile app (setter methods).
Extending the API: R3S Specifications
Developers who write extensions for Content Management Systems, or who want to integrate their own Content Management System with Weever can use the R3S Specifications to create feeds that Weever can understand and propigate into a mobile app.
