aboutsummaryrefslogtreecommitdiff
path: root/docs/fr/users
diff options
context:
space:
mode:
authorGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2018-06-03 13:14:42 +0200
committerGravatar GitHub <noreply@github.com> 2018-06-03 13:14:42 +0200
commit4b9f0710ebad4b07da1d5e95eced5771bf576847 (patch)
tree48b42aa0c49659c2c98a6057bd744796165dfe95 /docs/fr/users
parentccc62b0a2cb41663ebee7b33601c5fb1d000d4cb (diff)
A bit of API documentation (#1914)
https://github.com/FreshRSS/FreshRSS/issues/1754
Diffstat (limited to 'docs/fr/users')
-rw-r--r--docs/fr/users/06_Fever_API.md2
-rw-r--r--docs/fr/users/06_Mobile_access.md36
2 files changed, 37 insertions, 1 deletions
diff --git a/docs/fr/users/06_Fever_API.md b/docs/fr/users/06_Fever_API.md
index f9dcd5d73..6ad817041 100644
--- a/docs/fr/users/06_Fever_API.md
+++ b/docs/fr/users/06_Fever_API.md
@@ -1,5 +1,7 @@
# FreshRSS - API compatible Fever
+Voir la page [sur notre API compatible Google Reader](06_Mobile_access.md) pour une autre possibilité
+et des généralités sur l’accès par API.
## Compatibilité
diff --git a/docs/fr/users/06_Mobile_access.md b/docs/fr/users/06_Mobile_access.md
index 8ef3d038a..b8e7c31f0 100644
--- a/docs/fr/users/06_Mobile_access.md
+++ b/docs/fr/users/06_Mobile_access.md
@@ -7,6 +7,9 @@ Cette page suppose que vous avez fini [l’installation du serveur](01_Installat
* Chaque utilisateur doit choisir son mot de passe API.
* La raison d’être d’un mot de passe API différent du mot de passe principal est que le mot de passe API est potentiellement utilisé de manière moins sûre, mais il permet aussi moins de choses.
+Le reste de cette page concerne l’API compatible Google Reader.
+Voir la [page sur l’API compatible Fever](06_Fever_API.md) pour une autre possibilité.
+
# Tester
@@ -17,7 +20,7 @@ Cette page suppose que vous avez fini [l’installation du serveur](01_Installat
* Si vous obtenez un autre message d’erreur, passer à l’étape 5.
-# Débogger la configuration du serveur
+# Déboguer la configuration du serveur
5. Cliquer sur le second lien “Check partial server configuration (without `%2F` support)”:
* Si vous obtenez `PASS`, alors le problème est bien que votre serveur n’accepte pas les slashs `/` qui sont encodés `%2F`.
@@ -48,3 +51,34 @@ Tout client supportant une API de type Google Reader. Sélection :
* [EasyRSS](https://github.com/Alkarex/EasyRSS) (Libre, F-Droid)
* Linux
* [FeedReader 2.0+](https://jangernert.github.io/FeedReader/) (Libre)
+
+
+# API compatible Google Reader
+
+Exemples de requêtes simples:
+
+```sh
+# Authentification utilisant le mot de passe API (Email et Passwd peuvent être passés en GET, ou POST - mieux)
+curl 'https://freshrss.example.net/api/greader.php/accounts/ClientLogin?Email=alice&Passwd=Abcdef123456'
+SID=alice/8e6845e089457af25303abc6f53356eb60bdb5f8
+Auth=alice/8e6845e089457af25303abc6f53356eb60bdb5f8
+
+# Exemples de requêtes en lecture
+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'
+
+# Demande de jeton pour faire de requêtes de modification
+curl -H "Authorization:GoogleLogin auth=alice/8e6845e089457af25303abc6f53356eb60bdb5f8" \
+ 'https://freshrss.example.net/api/greader.php/reader/api/0/token'
+8e6845e089457af25303abc6f53356eb60bdb5f8ZZZZZZZZZZZZZZZZZ
+
+# Récupère les articles, envoyés à jq pour une lecture JSON plus facile
+curl -s -H "Authorization:GoogleLogin auth=alice/8e6845e089457af25303abc6f53356eb60bdb5f8" \
+ 'https://freshrss.example.net/api/greader.php/reader/api/0/stream/contents/reading-list' | jq .
+```