updates to the documentation

This commit is contained in:
Torsten Stelling
2013-06-29 18:41:27 +02:00
parent 00a1e1411a
commit db0468b870
2 changed files with 21 additions and 0 deletions

View File

@@ -36,9 +36,13 @@ These clients should be working fine with this API emulation.
* [Reeder](http://reederapp.com) - iPhone
* [Mr.Reader](http://www.curioustimes.de/mrreader/index.html) - iPad
* [ReadKit](http://readkitapp.com) - OS X
* [Meltdown](https://github.com/phubbard/Meltdown) - Android
* displays feeds as 'orphan' items, but runs fine
## <a name="installation">Installation</a>
**IMPORTENT** Enable external API access in your TinyTinyRSS installation! Otherwise this will not work!
Upload the ```fever``` folder in the ```plugins``` folder of your TinyTinyRSS installation. Enable the plugin in the preferences and set your password for the Fever API.
See [here](http://tt-rss.org/forum/viewtopic.php?f=22&t=1981) for more detailed informations.

View File

@@ -1,5 +1,7 @@
# API Public Beta
**Information** Currently it is a copy of [http://www.feedafever.com/api](http://www.feedafever.com/api), but as a Markdown File.
Fever 1.14 introduces the new Fever API. This API is in public beta and currently supports basic syncing and consuming of content. A subsequent update will allow for adding, editing and deleting feeds and groups. The APIs primary focus is maintaining a local cache of the data in a remote Fever installation.
I am [soliciting feedback](http://www.feedafever.com/contact) from interested developers and as such the beta API may expand to reflect that feedback. The current API is incomplete but stable. Existing features may be expanded on but will not be removed or modified. New features may be added.
@@ -222,3 +224,18 @@ Similarly you can mark just the “Sparks” super group as read by adding the f
* `as=read`
* `id=-1`
* `before=?` where `?` is replaced with the Unix timestamp of the the local clients last `items` API request
# inoffical API
This is the extension which represents some things which will be used from Mr.Reader App in iPad and are not documented as normal API, but allows it because the Fever API point is the same as the webpage requests.
## login
`http://yourdomain.com/fever/?action=login&username=[username]&password=[password]`
A request with the `action=login` argument will return a cookie `fever_auth`. This must be equal to the API key. This is a call which is created normally from the login dialog of the Fever webpage.
* `username` - the username for your login
* `password` - the password you set for the api
As return a cookie named `fever_auth` will be set with the API key.