diff options
| author | 2021-10-23 13:32:20 +0200 | |
|---|---|---|
| committer | 2021-10-23 13:32:20 +0200 | |
| commit | 915dcc3cccc9a78f3c169552a7186cac6bcc8962 (patch) | |
| tree | d5eae2c9d565e2c49eefed8044eaff387e85a889 /docs/en/users | |
| parent | cba304c35219cc1fa5300fcd0ef0a80272a62641 (diff) | |
Split fever & greader into two separate pages. (#3905)
* [docs] add newsflash to fever-clients
* [docs] split fever&greader-apis into two pages and make the more consistent
Diffstat (limited to 'docs/en/users')
| -rw-r--r-- | docs/en/users/06_Mobile_access.md | 59 |
1 files changed, 2 insertions, 57 deletions
diff --git a/docs/en/users/06_Mobile_access.md b/docs/en/users/06_Mobile_access.md index 67111cc55..59b3d6c52 100644 --- a/docs/en/users/06_Mobile_access.md +++ b/docs/en/users/06_Mobile_access.md @@ -7,8 +7,8 @@ This page assumes you have completed the [server setup](../admins/03_Installatio * Every user must define an API password. * The reason for an API-specific password is that it may be used in less safe situations than the main password, and does not grant access to as many things. -The rest of this page is about the Google Reader compatible API. -See the [page about the Fever compatible API](06_Fever_API.md) for another possibility. +See the [page about the Google Reader compatible API](../developers/06_GoogleReader_API.md.md) for more details. +See the [page about the Fever compatible API](../developers/06_Fever_API.md.md) for more details. # Testing @@ -39,58 +39,3 @@ See the [page about the Fever compatible API](06_Fever_API.md) for another possi * If you get *FAIL 64-bit or GMP extension!*, then your PHP version does not pass the requirement of being 64-bit and/or have PHP [GMP](http://php.net/gmp) extension. * The easiest is to add the GMP extension. On Debian / Ubuntu: `sudo apt install php-gmp` * Update and try again from step 3. - - -# Compatible clients - -6. On the same FreshRSS API page, note the address given under “Your API address”, like `https://freshrss.example.net/api/greader.php` - * Type the API address in a client, together with your FreshRSS username, and the corresponding special API password. - -7. Pick a client supporting a Google Reader-like API. Selection: - * Android - * [News+](https://play.google.com/store/apps/details?id=com.noinnion.android.newsplus) with [News+ Google Reader extension](https://github.com/noinnion/newsplus/blob/master/apk/GoogleReaderCloneExtension_101.apk) (Closed source) - * [FeedMe 3.5.3+](https://play.google.com/store/apps/details?id=com.seazon.feedme) (Closed source) - * [EasyRSS](https://github.com/Alkarex/EasyRSS) (Open source, [F-Droid](https://f-droid.org/packages/org.freshrss.easyrss/)) - * [Readrops](https://github.com/readrops/Readrops) (Open source) - * [FocusReader](https://play.google.com/store/apps/details?id=allen.town.focus.reader) (Commercial) - * Linux - * [FeedReader 2.0+](https://jangernert.github.io/FeedReader/) (Open source) - * [Newsboat 2.24+](https://newsboat.org/) (Open source) - * MacOS - * [Vienna RSS](http://www.vienna-rss.com/) (Open source) - * [Reeder](https://www.reederapp.com/) (Commercial) - * iOS - * [Reeder](https://www.reederapp.com/) (Commercial) - * Firefox - * [FreshRSS-Notify](https://addons.mozilla.org/firefox/addon/freshrss-notify-webextension/) (Open source) - - -# Google Reader compatible API - -Examples of basic queries: - -```sh -# Initial login, using API password (Email and Passwd can be given either as GET, or POST - better) -curl 'https://freshrss.example.net/api/greader.php/accounts/ClientLogin?Email=alice&Passwd=Abcdef123456' -SID=alice/8e6845e089457af25303abc6f53356eb60bdb5f8 -Auth=alice/8e6845e089457af25303abc6f53356eb60bdb5f8 - -# Examples of read-only requests -curl -s -H "Authorization:GoogleLogin auth=alice/8e6845e089457af25303abc6f53356eb60bdb5f8" \ - 'https://freshrss.example.net/api/greader.php/reader/api/0/subscription/list?output=json' - -curl -s -H "Authorization:GoogleLogin auth=alice/8e6845e089457af25303abc6f53356eb60bdb5f8" \ - 'https://freshrss.example.net/api/greader.php/reader/api/0/unread-count?output=json' - -curl -s -H "Authorization:GoogleLogin auth=alice/8e6845e089457af25303abc6f53356eb60bdb5f8" \ - 'https://freshrss.example.net/api/greader.php/reader/api/0/tag/list?output=json' - -# Retrieve a token for requests making modifications -curl -H "Authorization:GoogleLogin auth=alice/8e6845e089457af25303abc6f53356eb60bdb5f8" \ - 'https://freshrss.example.net/api/greader.php/reader/api/0/token' -8e6845e089457af25303abc6f53356eb60bdb5f8ZZZZZZZZZZZZZZZZZ - -# Get articles, piped to jq for easier JSON reading -curl -s -H "Authorization:GoogleLogin auth=alice/8e6845e089457af25303abc6f53356eb60bdb5f8" \ - 'https://freshrss.example.net/api/greader.php/reader/api/0/stream/contents/reading-list' | jq . -``` |
