From db0468b870a762e456b1a944236ec98c2bde8acd Mon Sep 17 00:00:00 2001 From: Torsten Stelling Date: Sat, 29 Jun 2013 18:41:27 +0200 Subject: [PATCH] updates to the documentation --- README.md | 4 ++++ fever-api.md | 17 +++++++++++++++++ 2 files changed, 21 insertions(+) diff --git a/README.md b/README.md index e6dd8e6..6a96a08 100644 --- a/README.md +++ b/README.md @@ -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 ## Installation +**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. diff --git a/fever-api.md b/fever-api.md index 5c27199..3b90dd4 100644 --- a/fever-api.md +++ b/fever-api.md @@ -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 API’s 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 client’s 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.