]> git.immae.eu Git - github/wallabag/wallabag.git/commitdiff
Documentation about wallabag API
authorNicolas Lœuillet <nicolas@loeuillet.org>
Wed, 6 Apr 2016 09:30:41 +0000 (11:30 +0200)
committerNicolas Lœuillet <nicolas@loeuillet.org>
Wed, 6 Apr 2016 09:30:41 +0000 (11:30 +0200)
16 files changed:
docs/en/developer/api.rst [new file with mode: 0644]
docs/en/index.rst
docs/fr/developer/api.rst [new file with mode: 0644]
docs/fr/index.rst
src/Wallabag/CoreBundle/Resources/translations/messages.da.yml
src/Wallabag/CoreBundle/Resources/translations/messages.de.yml
src/Wallabag/CoreBundle/Resources/translations/messages.en.yml
src/Wallabag/CoreBundle/Resources/translations/messages.es.yml
src/Wallabag/CoreBundle/Resources/translations/messages.fa.yml
src/Wallabag/CoreBundle/Resources/translations/messages.fr.yml
src/Wallabag/CoreBundle/Resources/translations/messages.oc.yml
src/Wallabag/CoreBundle/Resources/translations/messages.pl.yml
src/Wallabag/CoreBundle/Resources/translations/messages.ro.yml
src/Wallabag/CoreBundle/Resources/translations/messages.tr.yml
src/Wallabag/CoreBundle/Resources/views/themes/baggy/Developer/index.html.twig
src/Wallabag/CoreBundle/Resources/views/themes/material/Developer/index.html.twig

diff --git a/docs/en/developer/api.rst b/docs/en/developer/api.rst
new file mode 100644 (file)
index 0000000..ac00d3a
--- /dev/null
@@ -0,0 +1,235 @@
+API documentation
+=================
+
+Thanks to this documentation, we'll see how to interact with the wallabag API.
+
+Requirements
+------------
+
+* wallabag freshly (or not) installed on http://localhost:8000
+* ``httpie`` installed on your computer (`see project website <https://github.com/jkbrzt/httpie>`__). Note that you can also adapt the commands using curl or wget.
+* all the API methods are documented here http://localhost:8000/api/doc
+
+Creating a new API client
+-------------------------
+
+In your wallabag account, you can create a new API client at this URL http://localhost:8000/developer/client/create.
+
+Just give the redirect URL of your application and create your client. If your application is a desktop one, put whatever URL suits you the most.
+
+You get information like this:
+
+::
+
+    Client ID:
+
+    1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc
+
+    Client secret:
+
+    636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4
+
+
+Obtaining a refresh token
+-------------------------
+
+For each API call, you'll need a token. Let's create it with this command (replace ``client_id``, ``client_secret``, ``username`` and ``password`` with their values):
+
+::
+
+    http POST http://localhost:8000/oauth/v2/token \
+        grant_type=password \
+        client_id=1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc \
+        client_secret=636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4 \
+        username=wallabag \
+        password=wallabag
+
+You'll have this in return:
+
+::
+
+    HTTP/1.1 200 OK
+    Cache-Control: no-store, private
+    Connection: close
+    Content-Type: application/json
+    Date: Tue, 05 Apr 2016 08:44:33 GMT
+    Host: localhost:8000
+    Pragma: no-cache
+    X-Debug-Token: 19c8e0
+    X-Debug-Token-Link: /_profiler/19c8e0
+    X-Powered-By: PHP/7.0.4
+
+    {
+        "access_token": "ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA",
+        "expires_in": 3600,
+        "refresh_token": "OTNlZGE5OTJjNWQwYzc2NDI5ZGE5MDg3ZTNjNmNkYTY0ZWZhZDVhNDBkZTc1ZTNiMmQ0MjQ0OThlNTFjNTQyMQ",
+        "scope": null,
+        "token_type": "bearer"
+    }
+
+We'll work with the ``access_token`` value in our next calls.
+
+Getting existing entries
+------------------------
+
+Documentation for this method: http://localhost:8000/api/doc#get--api-entries.{_format}
+
+As we work on a fresh wallabag installation, we'll have no result with this command:
+
+::
+
+    http GET http://localhost:8000/api/entries.json \
+    "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA"
+
+returns:
+
+::
+
+    HTTP/1.1 200 OK
+    0: application/json
+    Cache-Control: no-cache
+    Connection: close
+    Content-Type: application/json
+    Date: Tue, 05 Apr 2016 08:51:32 GMT
+    Host: localhost:8000
+    Set-Cookie: PHPSESSID=nrogm748md610ovhu6j70c3q63; path=/; HttpOnly
+    X-Debug-Token: 4fbbc4
+    X-Debug-Token-Link: /_profiler/4fbbc4
+    X-Powered-By: PHP/7.0.4
+
+    {
+        "_embedded": {
+            "items": []
+        },
+        "_links": {
+            "first": {
+                "href": "http://localhost:8000/api/entries?page=1&perPage=30"
+            },
+            "last": {
+                "href": "http://localhost:8000/api/entries?page=1&perPage=30"
+            },
+            "self": {
+                "href": "http://localhost:8000/api/entries?page=1&perPage=30"
+            }
+        },
+        "limit": 30,
+        "page": 1,
+        "pages": 1,
+        "total": 0
+    }
+
+The ``items`` array is empty.
+
+Adding your first entry
+-----------------------
+
+Documentation for this method: http://localhost:8000/api/doc#post--api-entries.{_format}
+
+::
+
+    http POST http://localhost:8000/api/entries.json \
+    "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" \
+    url="http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html"
+
+returns
+
+::
+
+    HTTP/1.1 200 OK
+    0: application/json
+    Cache-Control: no-cache
+    Connection: close
+    Content-Type: application/json
+    Date: Tue, 05 Apr 2016 09:07:54 GMT
+    Host: localhost:8000
+    Set-Cookie: PHPSESSID=bjie40ck72kp2pst3i71gf43a4; path=/; HttpOnly
+    X-Debug-Token: e01c51
+    X-Debug-Token-Link: /_profiler/e01c51
+    X-Powered-By: PHP/7.0.4
+
+    {
+        "_links": {
+            "self": {
+                "href": "/api/entries/1"
+            }
+        },
+        "content": "<p class=\"chapo\">Fonctionnant sur le même principe que Pocket, Instapaper ou Readability, le logiciel Wallabag permet de mémoriser des articles pour les lire plus tard. Sa nouvelle version apporte une multitude de nouvelles fonctionnalités.</p><p>Si vous utilisez Firefox comme navigateur web, vous avez peut-être constaté l’arrivée d’<a href=\"http://www.numerama.com/magazine/33292-update-firefox.html\">une fonctionnalité intitulée Pocket</a>. Disponible autrefois sous la forme d’un module complémentaire, et sous un autre nom (Read it Later), elle est depuis le mois de juin 2015 directement incluse au sein de Firefox.</p>\n<p>Concrètement, Pocket sert à garder en mémoire des contenus que vous croisez au fil de la navigation, comme des articles de presse ou des vidéos, afin de pouvoir les consulter plus tard. Pocket fonctionne un peu comme un système de favoris, mais en bien plus élaboré grâce à ses options supplémentaires.</p>\n<p>Mais <a href=\"https://en.wikipedia.org/wiki/Pocket_%28application%29#Firefox_integration\" target=\"_blank\">Pocket fait polémique</a>, car il s’agit d’un projet propriétaire qui est intégré dans un logiciel libre. C’est pour cette raison que des utilisateurs ont choisi de se tourner vers d’autres solutions, comme <strong>Wallabag</strong>, qui est l’équivalent libre de Pocket et d’autres systèmes du même genre, comme Instapaper et Readability.</p>\n<p>Et justement, Wallabag évolue. C’est ce dimanche que la <a href=\"https://www.wallabag.org/blog/2016/04/03/wallabag-v2\" target=\"_blank\">version 2.0.0 du logiciel</a> a été publiée par l’équipe en  charge de son développement et celle-ci contient de nombreux changements par rapport aux moutures précédentes (la <a href=\"http://doc.wallabag.org/fr/v2/\" target=\"_blank\">documentation est traduite</a> en français), lui permettant d’apparaître comme une alternative à Pocket, Instapaper et Readability.</p>\n<p><img class=\"aligncenter size-medium wp-image-160439\" src=\"http://www.numerama.com/content/uploads/2016/04/homepage-680x347.png\" alt=\"homepage\" width=\"680\" height=\"347\" srcset=\"//www.numerama.com/content/uploads/2016/04/homepage-680x347.png 680w, //www.numerama.com/content/uploads/2016/04/homepage-1024x523.png 1024w, //www.numerama.com/content/uploads/2016/04/homepage-270x138.png 270w, //www.numerama.com/content/uploads/2016/04/homepage.png 1286w\" sizes=\"(max-width: 680px) 100vw, 680px\"/></p>\n<p>Parmi les principaux changements que l’on peut retenir avec cette nouvelle version, notons la possibilité d’écrire des annotations dans les articles mémorisés, de filtrer les contenus selon divers critères (temps de lecture, nom de domaine, date de création, statut…), d’assigner des mots-clés aux entrées, de modifier le titre des articles, le support des flux RSS ou encore le support de plusieurs langues dont le français.</p>\n<p>D’autres options sont également à signaler, comme l’aperçu d’un article mémorisé (si l’option est disponible), un guide de démarrage rapide pour les débutants, un outil d’export dans divers formats (PDF, JSON, EPUB, MOBI, XML, CSV et TXT) et, surtout, la possibilité de migrer vers Wallabag depuis Pocket, afin de convaincre les usagers de se lancer.</p>\n    \n    \n    <footer class=\"clearfix\" readability=\"1\"><p class=\"source\">\n        Crédit photo de la une : <a href=\"https://www.flickr.com/photos/bookgrl/2388310523/\">Laura Taylor</a>\n    </p>\n    \n    <p><a href=\"http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html?&amp;show_reader_reports\" target=\"_blank\" rel=\"nofollow\">Signaler une erreur dans le texte</a></p>\n        \n</footer>    <section class=\"related-article\"><header><h3>Articles liés</h3>\n    </header><article class=\"post-grid format-article\"><a class=\"floatleft\" href=\"http://www.numerama.com/magazine/34444-firefox-prepare-l-enterrement-des-vieux-plugins.html\" title=\"Firefox prépare l'enterrement des vieux plugins\">\n        <div class=\"cover-preview cover-tech\">\n                            <p>Lire</p>\n            \n                            \n            \n            <img class=\"cover-preview_img\" src=\"http://c2.lestechnophiles.com/www.numerama.com/content/uploads/2015/10/cimetierecolleville.jpg?resize=200,135\" srcset=\"&#10;                    //c2.lestechnophiles.com/www.numerama.com/content/uploads/2015/10/cimetierecolleville.jpg?resize=200,135 200w,&#10;                                            //c2.lestechnophiles.com/www.numerama.com/content/uploads/2015/10/cimetierecolleville.jpg?resize=100,67 100w,&#10;                                        \" sizes=\"(min-width: 1001px) 200px, (max-width: 1000px) 100px\" alt=\"Firefox prépare l'enterrement des vieux plugins\"/></div>\n        <h4> Firefox prépare l'enterrement des vieux plugins </h4>\n    </a>\n    <footer class=\"span12\">\n    </footer></article><article class=\"post-grid format-article\"><a class=\"floatleft\" href=\"http://www.numerama.com/tech/131636-activer-navigation-privee-navigateur-web.html\" title=\"Comment activer la navigation privée sur son navigateur web\">\n        <div class=\"cover-preview cover-tech\">\n                            <p>Lire</p>\n            \n                            \n            \n            <img class=\"cover-preview_img\" src=\"http://c1.lestechnophiles.com/www.numerama.com/content/uploads/2015/11/Incognito.jpg?resize=200,135\" srcset=\"&#10;                    //c1.lestechnophiles.com/www.numerama.com/content/uploads/2015/11/Incognito.jpg?resize=200,135 200w,&#10;                                            //c1.lestechnophiles.com/www.numerama.com/content/uploads/2015/11/Incognito.jpg?resize=100,67 100w,&#10;                                        \" sizes=\"(min-width: 1001px) 200px, (max-width: 1000px) 100px\" alt=\"Comment activer la navigation privée sur son navigateur web\"/></div>\n        <h4> Comment activer la navigation privée sur son navigateur web </h4>\n    </a>\n    <footer class=\"span12\">\n    </footer></article><article class=\"post-grid format-article\"><a class=\"floatleft\" href=\"http://www.numerama.com/tech/144028-firefox-se-mettra-a-jour-regulierement.html\" title=\"Firefox se mettra à jour un peu moins régulièrement\">\n        <div class=\"cover-preview cover-tech\">\n                            <p>Lire</p>\n            \n                            \n            \n            <img class=\"cover-preview_img\" src=\"http://c0.lestechnophiles.com/www.numerama.com/content/uploads/2016/02/firefox-mobile.jpg?resize=200,135\" srcset=\"&#10;                    //c0.lestechnophiles.com/www.numerama.com/content/uploads/2016/02/firefox-mobile.jpg?resize=200,135 200w,&#10;                                            //c0.lestechnophiles.com/www.numerama.com/content/uploads/2016/02/firefox-mobile.jpg?resize=100,67 100w,&#10;                                        \" sizes=\"(min-width: 1001px) 200px, (max-width: 1000px) 100px\" alt=\"Firefox se mettra à jour un peu moins régulièrement\"/></div>\n        <h4> Firefox se mettra à jour un peu moins régulièrement </h4>\n    </a>\n    <footer class=\"span12\">\n    </footer></article>\n</section>\n",
+        "created_at": "2016-04-05T09:07:54+0000",
+        "domain_name": "www.numerama.com",
+        "id": 1,
+        "is_archived": 0,
+        "is_starred": 0,
+        "language": "fr-FR",
+        "mimetype": "text/html",
+        "preview_picture": "http://www.numerama.com/content/uploads/2016/04/post-it.jpg",
+        "reading_time": 2,
+        "tags": [],
+        "title": "Le Pocket libre Wallabag fait le plein de fonctionnalités - Tech - Numerama",
+        "updated_at": "2016-04-05T09:07:54+0000",
+        "url": "http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html",
+        "user_email": "",
+        "user_id": 1,
+        "user_name": "wallabag"
+    }
+
+Now, if you execute the previous command (see **Get existing entries**), you'll have data.
+
+Deleting an entry
+-----------------
+
+Documentation for this method: http://localhost:8000/api/doc#delete--api-entries-{entry}.{_format}
+
+::
+
+    http DELETE http://localhost:8000/api/entries/1.json \
+    "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA"
+
+returns
+
+::
+
+    HTTP/1.1 200 OK
+    0: application/json
+    Cache-Control: no-cache
+    Connection: close
+    Content-Type: application/json
+    Date: Tue, 05 Apr 2016 09:19:07 GMT
+    Host: localhost:8000
+    Set-Cookie: PHPSESSID=jopgnfvmuc9a62b27sqm6iulr6; path=/; HttpOnly
+    X-Debug-Token: 887cef
+    X-Debug-Token-Link: /_profiler/887cef
+    X-Powered-By: PHP/7.0.4
+
+    {
+        "_links": {
+            "self": {
+                "href": "/api/entries/"
+            }
+        },
+        "annotations": [],
+        "content": "<p class=\"chapo\">Fonctionnant sur le même principe que Pocket, Instapaper ou Readability, le logiciel Wallabag permet de mémoriser des articles pour les lire plus tard. Sa nouvelle version apporte une multitude de nouvelles fonctionnalités.</p><p>Si vous utilisez Firefox comme navigateur web, vous avez peut-être constaté l’arrivée d’<a href=\"http://www.numerama.com/magazine/33292-update-firefox.html\">une fonctionnalité intitulée Pocket</a>. Disponible autrefois sous la forme d’un module complémentaire, et sous un autre nom (Read it Later), elle est depuis le mois de juin 2015 directement incluse au sein de Firefox.</p>\n<p>Concrètement, Pocket sert à garder en mémoire des contenus que vous croisez au fil de la navigation, comme des articles de presse ou des vidéos, afin de pouvoir les consulter plus tard. Pocket fonctionne un peu comme un système de favoris, mais en bien plus élaboré grâce à ses options supplémentaires.</p>\n<p>Mais <a href=\"https://en.wikipedia.org/wiki/Pocket_%28application%29#Firefox_integration\" target=\"_blank\">Pocket fait polémique</a>, car il s’agit d’un projet propriétaire qui est intégré dans un logiciel libre. C’est pour cette raison que des utilisateurs ont choisi de se tourner vers d’autres solutions, comme <strong>Wallabag</strong>, qui est l’équivalent libre de Pocket et d’autres systèmes du même genre, comme Instapaper et Readability.</p>\n<p>Et justement, Wallabag évolue. C’est ce dimanche que la <a href=\"https://www.wallabag.org/blog/2016/04/03/wallabag-v2\" target=\"_blank\">version 2.0.0 du logiciel</a> a été publiée par l’équipe en  charge de son développement et celle-ci contient de nombreux changements par rapport aux moutures précédentes (la <a href=\"http://doc.wallabag.org/fr/v2/\" target=\"_blank\">documentation est traduite</a> en français), lui permettant d’apparaître comme une alternative à Pocket, Instapaper et Readability.</p>\n<p><img class=\"aligncenter size-medium wp-image-160439\" src=\"http://www.numerama.com/content/uploads/2016/04/homepage-680x347.png\" alt=\"homepage\" width=\"680\" height=\"347\" srcset=\"//www.numerama.com/content/uploads/2016/04/homepage-680x347.png 680w, //www.numerama.com/content/uploads/2016/04/homepage-1024x523.png 1024w, //www.numerama.com/content/uploads/2016/04/homepage-270x138.png 270w, //www.numerama.com/content/uploads/2016/04/homepage.png 1286w\" sizes=\"(max-width: 680px) 100vw, 680px\"/></p>\n<p>Parmi les principaux changements que l’on peut retenir avec cette nouvelle version, notons la possibilité d’écrire des annotations dans les articles mémorisés, de filtrer les contenus selon divers critères (temps de lecture, nom de domaine, date de création, statut…), d’assigner des mots-clés aux entrées, de modifier le titre des articles, le support des flux RSS ou encore le support de plusieurs langues dont le français.</p>\n<p>D’autres options sont également à signaler, comme l’aperçu d’un article mémorisé (si l’option est disponible), un guide de démarrage rapide pour les débutants, un outil d’export dans divers formats (PDF, JSON, EPUB, MOBI, XML, CSV et TXT) et, surtout, la possibilité de migrer vers Wallabag depuis Pocket, afin de convaincre les usagers de se lancer.</p>\n    \n    \n    <footer class=\"clearfix\" readability=\"1\"><p class=\"source\">\n        Crédit photo de la une : <a href=\"https://www.flickr.com/photos/bookgrl/2388310523/\">Laura Taylor</a>\n    </p>\n    \n    <p><a href=\"http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html?&amp;show_reader_reports\" target=\"_blank\" rel=\"nofollow\">Signaler une erreur dans le texte</a></p>\n        \n</footer>    <section class=\"related-article\"><header><h3>Articles liés</h3>\n    </header><article class=\"post-grid format-article\"><a class=\"floatleft\" href=\"http://www.numerama.com/magazine/34444-firefox-prepare-l-enterrement-des-vieux-plugins.html\" title=\"Firefox prépare l'enterrement des vieux plugins\">\n        <div class=\"cover-preview cover-tech\">\n                            <p>Lire</p>\n            \n                            \n            \n            <img class=\"cover-preview_img\" src=\"http://c2.lestechnophiles.com/www.numerama.com/content/uploads/2015/10/cimetierecolleville.jpg?resize=200,135\" srcset=\"&#10;                    //c2.lestechnophiles.com/www.numerama.com/content/uploads/2015/10/cimetierecolleville.jpg?resize=200,135 200w,&#10;                                            //c2.lestechnophiles.com/www.numerama.com/content/uploads/2015/10/cimetierecolleville.jpg?resize=100,67 100w,&#10;                                        \" sizes=\"(min-width: 1001px) 200px, (max-width: 1000px) 100px\" alt=\"Firefox prépare l'enterrement des vieux plugins\"/></div>\n        <h4> Firefox prépare l'enterrement des vieux plugins </h4>\n    </a>\n    <footer class=\"span12\">\n    </footer></article><article class=\"post-grid format-article\"><a class=\"floatleft\" href=\"http://www.numerama.com/tech/131636-activer-navigation-privee-navigateur-web.html\" title=\"Comment activer la navigation privée sur son navigateur web\">\n        <div class=\"cover-preview cover-tech\">\n                            <p>Lire</p>\n            \n                            \n            \n            <img class=\"cover-preview_img\" src=\"http://c1.lestechnophiles.com/www.numerama.com/content/uploads/2015/11/Incognito.jpg?resize=200,135\" srcset=\"&#10;                    //c1.lestechnophiles.com/www.numerama.com/content/uploads/2015/11/Incognito.jpg?resize=200,135 200w,&#10;                                            //c1.lestechnophiles.com/www.numerama.com/content/uploads/2015/11/Incognito.jpg?resize=100,67 100w,&#10;                                        \" sizes=\"(min-width: 1001px) 200px, (max-width: 1000px) 100px\" alt=\"Comment activer la navigation privée sur son navigateur web\"/></div>\n        <h4> Comment activer la navigation privée sur son navigateur web </h4>\n    </a>\n    <footer class=\"span12\">\n    </footer></article><article class=\"post-grid format-article\"><a class=\"floatleft\" href=\"http://www.numerama.com/tech/144028-firefox-se-mettra-a-jour-regulierement.html\" title=\"Firefox se mettra à jour un peu moins régulièrement\">\n        <div class=\"cover-preview cover-tech\">\n                            <p>Lire</p>\n            \n                            \n            \n            <img class=\"cover-preview_img\" src=\"http://c0.lestechnophiles.com/www.numerama.com/content/uploads/2016/02/firefox-mobile.jpg?resize=200,135\" srcset=\"&#10;                    //c0.lestechnophiles.com/www.numerama.com/content/uploads/2016/02/firefox-mobile.jpg?resize=200,135 200w,&#10;                                            //c0.lestechnophiles.com/www.numerama.com/content/uploads/2016/02/firefox-mobile.jpg?resize=100,67 100w,&#10;                                        \" sizes=\"(min-width: 1001px) 200px, (max-width: 1000px) 100px\" alt=\"Firefox se mettra à jour un peu moins régulièrement\"/></div>\n        <h4> Firefox se mettra à jour un peu moins régulièrement </h4>\n    </a>\n    <footer class=\"span12\">\n    </footer></article>\n</section>\n",
+        "created_at": "2016-04-05T09:07:54+0000",
+        "domain_name": "www.numerama.com",
+        "is_archived": 0,
+        "is_starred": 0,
+        "language": "fr-FR",
+        "mimetype": "text/html",
+        "preview_picture": "http://www.numerama.com/content/uploads/2016/04/post-it.jpg",
+        "reading_time": 2,
+        "tags": [],
+        "title": "Le Pocket libre Wallabag fait le plein de fonctionnalités - Tech - Numerama",
+        "updated_at": "2016-04-05T09:07:54+0000",
+        "url": "http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html",
+        "user_email": "",
+        "user_id": 1,
+        "user_name": "wallabag"
+    }
+
+And if you want to list the existing entries (see **Get existing entries**), the array is empty.
+
+Other methods
+-------------
+
+We won't write samples for each API method.
+
+Have a look on the listing here: http://localhost:8000/api/doc to know each method.
index 66caac39965c458309cff1e9a817f4f8e70f8a8f..87b62121a167cd37af55419dc17c5e99c2582ada 100644 (file)
@@ -42,7 +42,7 @@ The main documentation for this application is organized into a couple sections:
    :maxdepth: 2
    :caption: Developer documentation
 
+   developer/api
    developer/docker
    developer/translate
    developer/maintenance
-   developer/releasing
diff --git a/docs/fr/developer/api.rst b/docs/fr/developer/api.rst
new file mode 100644 (file)
index 0000000..9c8e25a
--- /dev/null
@@ -0,0 +1,235 @@
+Documentation de l'API
+======================
+
+Grâce à cette documentation, nous allons voir comment interagir avec l'API de wallabag.
+
+Pré-requis
+----------
+
+* wallabag fraichement installé et disponible à http://localhost:8000
+* ``httpie`` installé sur votre ordinateur (`voir le site du projet <https://github.com/jkbrzt/httpie>`__). Vous pouvez également adapter les commandes en utilisant curl ou wget. 
+* toutes les méthodes de l'API documentées ici http://localhost:8000/api/doc
+
+Créer un nouveau client d'API
+-----------------------------
+
+Depuis votre wallabag, vous pouvez créer un nouveau client d'API à cette URL http://localhost:8000/developer/client/create.
+
+Vous devez renseigner l'URL de redirection de votre application et créer votre client. Si votre application est une application desktop, renseignez l'URL que vous souhaitez.
+
+Vous obtiendrez les informations suivantes :
+
+::
+
+    Client ID:
+
+    1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc
+
+    Client secret:
+
+    636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4
+
+
+Créer un jeton
+--------------
+
+Pour chaque appel d'API, vous aurez besoin d'un jeton. Créons-le avec la commande suivante (remplacez ``client_id``, ``client_secret``, ``username`` and ``password`` par leur valeur):
+
+::
+
+    http POST http://localhost:8000/oauth/v2/token \
+        grant_type=password \
+        client_id=1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc \
+        client_secret=636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4 \
+        username=wallabag \
+        password=wallabag
+
+Vous obtiendrez :
+
+::
+
+    HTTP/1.1 200 OK
+    Cache-Control: no-store, private
+    Connection: close
+    Content-Type: application/json
+    Date: Tue, 05 Apr 2016 08:44:33 GMT
+    Host: localhost:8000
+    Pragma: no-cache
+    X-Debug-Token: 19c8e0
+    X-Debug-Token-Link: /_profiler/19c8e0
+    X-Powered-By: PHP/7.0.4
+
+    {
+        "access_token": "ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA",
+        "expires_in": 3600,
+        "refresh_token": "OTNlZGE5OTJjNWQwYzc2NDI5ZGE5MDg3ZTNjNmNkYTY0ZWZhZDVhNDBkZTc1ZTNiMmQ0MjQ0OThlNTFjNTQyMQ",
+        "scope": null,
+        "token_type": "bearer"
+    }
+
+Nous allons utiliser la valeur de ``access_token`` dans nos prochains appels.
+
+Récupérer les articles existants
+--------------------------------
+
+Documentation pour cette méthode : http://localhost:8000/api/doc#get--api-entries.{_format}
+
+Comme nous venons tout juste d'installer wallabag, nous n'aurons aucun résultat avec cette commande :
+
+::
+
+    http GET http://localhost:8000/api/entries.json \
+    "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA"
+
+retournera :
+
+::
+
+    HTTP/1.1 200 OK
+    0: application/json
+    Cache-Control: no-cache
+    Connection: close
+    Content-Type: application/json
+    Date: Tue, 05 Apr 2016 08:51:32 GMT
+    Host: localhost:8000
+    Set-Cookie: PHPSESSID=nrogm748md610ovhu6j70c3q63; path=/; HttpOnly
+    X-Debug-Token: 4fbbc4
+    X-Debug-Token-Link: /_profiler/4fbbc4
+    X-Powered-By: PHP/7.0.4
+
+    {
+        "_embedded": {
+            "items": []
+        },
+        "_links": {
+            "first": {
+                "href": "http://localhost:8000/api/entries?page=1&perPage=30"
+            },
+            "last": {
+                "href": "http://localhost:8000/api/entries?page=1&perPage=30"
+            },
+            "self": {
+                "href": "http://localhost:8000/api/entries?page=1&perPage=30"
+            }
+        },
+        "limit": 30,
+        "page": 1,
+        "pages": 1,
+        "total": 0
+    }
+
+Le tableau ``items`` est vide.
+
+Créer votre premier article
+---------------------------
+
+Documentation pour cette méthode : http://localhost:8000/api/doc#post--api-entries.{_format}
+
+::
+
+    http POST http://localhost:8000/api/entries.json \
+    "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" \
+    url="http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html"
+
+retournera :
+
+::
+
+    HTTP/1.1 200 OK
+    0: application/json
+    Cache-Control: no-cache
+    Connection: close
+    Content-Type: application/json
+    Date: Tue, 05 Apr 2016 09:07:54 GMT
+    Host: localhost:8000
+    Set-Cookie: PHPSESSID=bjie40ck72kp2pst3i71gf43a4; path=/; HttpOnly
+    X-Debug-Token: e01c51
+    X-Debug-Token-Link: /_profiler/e01c51
+    X-Powered-By: PHP/7.0.4
+
+    {
+        "_links": {
+            "self": {
+                "href": "/api/entries/1"
+            }
+        },
+        "content": "<p class=\"chapo\">Fonctionnant sur le même principe que Pocket, Instapaper ou Readability, le logiciel Wallabag permet de mémoriser des articles pour les lire plus tard. Sa nouvelle version apporte une multitude de nouvelles fonctionnalités.</p><p>Si vous utilisez Firefox comme navigateur web, vous avez peut-être constaté l’arrivée d’<a href=\"http://www.numerama.com/magazine/33292-update-firefox.html\">une fonctionnalité intitulée Pocket</a>. Disponible autrefois sous la forme d’un module complémentaire, et sous un autre nom (Read it Later), elle est depuis le mois de juin 2015 directement incluse au sein de Firefox.</p>\n<p>Concrètement, Pocket sert à garder en mémoire des contenus que vous croisez au fil de la navigation, comme des articles de presse ou des vidéos, afin de pouvoir les consulter plus tard. Pocket fonctionne un peu comme un système de favoris, mais en bien plus élaboré grâce à ses options supplémentaires.</p>\n<p>Mais <a href=\"https://en.wikipedia.org/wiki/Pocket_%28application%29#Firefox_integration\" target=\"_blank\">Pocket fait polémique</a>, car il s’agit d’un projet propriétaire qui est intégré dans un logiciel libre. C’est pour cette raison que des utilisateurs ont choisi de se tourner vers d’autres solutions, comme <strong>Wallabag</strong>, qui est l’équivalent libre de Pocket et d’autres systèmes du même genre, comme Instapaper et Readability.</p>\n<p>Et justement, Wallabag évolue. C’est ce dimanche que la <a href=\"https://www.wallabag.org/blog/2016/04/03/wallabag-v2\" target=\"_blank\">version 2.0.0 du logiciel</a> a été publiée par l’équipe en  charge de son développement et celle-ci contient de nombreux changements par rapport aux moutures précédentes (la <a href=\"http://doc.wallabag.org/fr/v2/\" target=\"_blank\">documentation est traduite</a> en français), lui permettant d’apparaître comme une alternative à Pocket, Instapaper et Readability.</p>\n<p><img class=\"aligncenter size-medium wp-image-160439\" src=\"http://www.numerama.com/content/uploads/2016/04/homepage-680x347.png\" alt=\"homepage\" width=\"680\" height=\"347\" srcset=\"//www.numerama.com/content/uploads/2016/04/homepage-680x347.png 680w, //www.numerama.com/content/uploads/2016/04/homepage-1024x523.png 1024w, //www.numerama.com/content/uploads/2016/04/homepage-270x138.png 270w, //www.numerama.com/content/uploads/2016/04/homepage.png 1286w\" sizes=\"(max-width: 680px) 100vw, 680px\"/></p>\n<p>Parmi les principaux changements que l’on peut retenir avec cette nouvelle version, notons la possibilité d’écrire des annotations dans les articles mémorisés, de filtrer les contenus selon divers critères (temps de lecture, nom de domaine, date de création, statut…), d’assigner des mots-clés aux entrées, de modifier le titre des articles, le support des flux RSS ou encore le support de plusieurs langues dont le français.</p>\n<p>D’autres options sont également à signaler, comme l’aperçu d’un article mémorisé (si l’option est disponible), un guide de démarrage rapide pour les débutants, un outil d’export dans divers formats (PDF, JSON, EPUB, MOBI, XML, CSV et TXT) et, surtout, la possibilité de migrer vers Wallabag depuis Pocket, afin de convaincre les usagers de se lancer.</p>\n    \n    \n    <footer class=\"clearfix\" readability=\"1\"><p class=\"source\">\n        Crédit photo de la une : <a href=\"https://www.flickr.com/photos/bookgrl/2388310523/\">Laura Taylor</a>\n    </p>\n    \n    <p><a href=\"http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html?&amp;show_reader_reports\" target=\"_blank\" rel=\"nofollow\">Signaler une erreur dans le texte</a></p>\n        \n</footer>    <section class=\"related-article\"><header><h3>Articles liés</h3>\n    </header><article class=\"post-grid format-article\"><a class=\"floatleft\" href=\"http://www.numerama.com/magazine/34444-firefox-prepare-l-enterrement-des-vieux-plugins.html\" title=\"Firefox prépare l'enterrement des vieux plugins\">\n        <div class=\"cover-preview cover-tech\">\n                            <p>Lire</p>\n            \n                            \n            \n            <img class=\"cover-preview_img\" src=\"http://c2.lestechnophiles.com/www.numerama.com/content/uploads/2015/10/cimetierecolleville.jpg?resize=200,135\" srcset=\"&#10;                    //c2.lestechnophiles.com/www.numerama.com/content/uploads/2015/10/cimetierecolleville.jpg?resize=200,135 200w,&#10;                                            //c2.lestechnophiles.com/www.numerama.com/content/uploads/2015/10/cimetierecolleville.jpg?resize=100,67 100w,&#10;                                        \" sizes=\"(min-width: 1001px) 200px, (max-width: 1000px) 100px\" alt=\"Firefox prépare l'enterrement des vieux plugins\"/></div>\n        <h4> Firefox prépare l'enterrement des vieux plugins </h4>\n    </a>\n    <footer class=\"span12\">\n    </footer></article><article class=\"post-grid format-article\"><a class=\"floatleft\" href=\"http://www.numerama.com/tech/131636-activer-navigation-privee-navigateur-web.html\" title=\"Comment activer la navigation privée sur son navigateur web\">\n        <div class=\"cover-preview cover-tech\">\n                            <p>Lire</p>\n            \n                            \n            \n            <img class=\"cover-preview_img\" src=\"http://c1.lestechnophiles.com/www.numerama.com/content/uploads/2015/11/Incognito.jpg?resize=200,135\" srcset=\"&#10;                    //c1.lestechnophiles.com/www.numerama.com/content/uploads/2015/11/Incognito.jpg?resize=200,135 200w,&#10;                                            //c1.lestechnophiles.com/www.numerama.com/content/uploads/2015/11/Incognito.jpg?resize=100,67 100w,&#10;                                        \" sizes=\"(min-width: 1001px) 200px, (max-width: 1000px) 100px\" alt=\"Comment activer la navigation privée sur son navigateur web\"/></div>\n        <h4> Comment activer la navigation privée sur son navigateur web </h4>\n    </a>\n    <footer class=\"span12\">\n    </footer></article><article class=\"post-grid format-article\"><a class=\"floatleft\" href=\"http://www.numerama.com/tech/144028-firefox-se-mettra-a-jour-regulierement.html\" title=\"Firefox se mettra à jour un peu moins régulièrement\">\n        <div class=\"cover-preview cover-tech\">\n                            <p>Lire</p>\n            \n                            \n            \n            <img class=\"cover-preview_img\" src=\"http://c0.lestechnophiles.com/www.numerama.com/content/uploads/2016/02/firefox-mobile.jpg?resize=200,135\" srcset=\"&#10;                    //c0.lestechnophiles.com/www.numerama.com/content/uploads/2016/02/firefox-mobile.jpg?resize=200,135 200w,&#10;                                            //c0.lestechnophiles.com/www.numerama.com/content/uploads/2016/02/firefox-mobile.jpg?resize=100,67 100w,&#10;                                        \" sizes=\"(min-width: 1001px) 200px, (max-width: 1000px) 100px\" alt=\"Firefox se mettra à jour un peu moins régulièrement\"/></div>\n        <h4> Firefox se mettra à jour un peu moins régulièrement </h4>\n    </a>\n    <footer class=\"span12\">\n    </footer></article>\n</section>\n",
+        "created_at": "2016-04-05T09:07:54+0000",
+        "domain_name": "www.numerama.com",
+        "id": 1,
+        "is_archived": 0,
+        "is_starred": 0,
+        "language": "fr-FR",
+        "mimetype": "text/html",
+        "preview_picture": "http://www.numerama.com/content/uploads/2016/04/post-it.jpg",
+        "reading_time": 2,
+        "tags": [],
+        "title": "Le Pocket libre Wallabag fait le plein de fonctionnalités - Tech - Numerama",
+        "updated_at": "2016-04-05T09:07:54+0000",
+        "url": "http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html",
+        "user_email": "",
+        "user_id": 1,
+        "user_name": "wallabag"
+    }
+
+Maintenant, si vous exécutez la précédente commande (voir **Récupérer les articles existants**), vous obtiendrez quelque chose.
+
+Supprimer un article
+--------------------
+
+Documentation pour cette méthode : http://localhost:8000/api/doc#delete--api-entries-{entry}.{_format}
+
+::
+
+    http DELETE http://localhost:8000/api/entries/1.json \
+    "Authorization:Bearer ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA"
+
+retournera :
+
+::
+
+    HTTP/1.1 200 OK
+    0: application/json
+    Cache-Control: no-cache
+    Connection: close
+    Content-Type: application/json
+    Date: Tue, 05 Apr 2016 09:19:07 GMT
+    Host: localhost:8000
+    Set-Cookie: PHPSESSID=jopgnfvmuc9a62b27sqm6iulr6; path=/; HttpOnly
+    X-Debug-Token: 887cef
+    X-Debug-Token-Link: /_profiler/887cef
+    X-Powered-By: PHP/7.0.4
+
+    {
+        "_links": {
+            "self": {
+                "href": "/api/entries/"
+            }
+        },
+        "annotations": [],
+        "content": "<p class=\"chapo\">Fonctionnant sur le même principe que Pocket, Instapaper ou Readability, le logiciel Wallabag permet de mémoriser des articles pour les lire plus tard. Sa nouvelle version apporte une multitude de nouvelles fonctionnalités.</p><p>Si vous utilisez Firefox comme navigateur web, vous avez peut-être constaté l’arrivée d’<a href=\"http://www.numerama.com/magazine/33292-update-firefox.html\">une fonctionnalité intitulée Pocket</a>. Disponible autrefois sous la forme d’un module complémentaire, et sous un autre nom (Read it Later), elle est depuis le mois de juin 2015 directement incluse au sein de Firefox.</p>\n<p>Concrètement, Pocket sert à garder en mémoire des contenus que vous croisez au fil de la navigation, comme des articles de presse ou des vidéos, afin de pouvoir les consulter plus tard. Pocket fonctionne un peu comme un système de favoris, mais en bien plus élaboré grâce à ses options supplémentaires.</p>\n<p>Mais <a href=\"https://en.wikipedia.org/wiki/Pocket_%28application%29#Firefox_integration\" target=\"_blank\">Pocket fait polémique</a>, car il s’agit d’un projet propriétaire qui est intégré dans un logiciel libre. C’est pour cette raison que des utilisateurs ont choisi de se tourner vers d’autres solutions, comme <strong>Wallabag</strong>, qui est l’équivalent libre de Pocket et d’autres systèmes du même genre, comme Instapaper et Readability.</p>\n<p>Et justement, Wallabag évolue. C’est ce dimanche que la <a href=\"https://www.wallabag.org/blog/2016/04/03/wallabag-v2\" target=\"_blank\">version 2.0.0 du logiciel</a> a été publiée par l’équipe en  charge de son développement et celle-ci contient de nombreux changements par rapport aux moutures précédentes (la <a href=\"http://doc.wallabag.org/fr/v2/\" target=\"_blank\">documentation est traduite</a> en français), lui permettant d’apparaître comme une alternative à Pocket, Instapaper et Readability.</p>\n<p><img class=\"aligncenter size-medium wp-image-160439\" src=\"http://www.numerama.com/content/uploads/2016/04/homepage-680x347.png\" alt=\"homepage\" width=\"680\" height=\"347\" srcset=\"//www.numerama.com/content/uploads/2016/04/homepage-680x347.png 680w, //www.numerama.com/content/uploads/2016/04/homepage-1024x523.png 1024w, //www.numerama.com/content/uploads/2016/04/homepage-270x138.png 270w, //www.numerama.com/content/uploads/2016/04/homepage.png 1286w\" sizes=\"(max-width: 680px) 100vw, 680px\"/></p>\n<p>Parmi les principaux changements que l’on peut retenir avec cette nouvelle version, notons la possibilité d’écrire des annotations dans les articles mémorisés, de filtrer les contenus selon divers critères (temps de lecture, nom de domaine, date de création, statut…), d’assigner des mots-clés aux entrées, de modifier le titre des articles, le support des flux RSS ou encore le support de plusieurs langues dont le français.</p>\n<p>D’autres options sont également à signaler, comme l’aperçu d’un article mémorisé (si l’option est disponible), un guide de démarrage rapide pour les débutants, un outil d’export dans divers formats (PDF, JSON, EPUB, MOBI, XML, CSV et TXT) et, surtout, la possibilité de migrer vers Wallabag depuis Pocket, afin de convaincre les usagers de se lancer.</p>\n    \n    \n    <footer class=\"clearfix\" readability=\"1\"><p class=\"source\">\n        Crédit photo de la une : <a href=\"https://www.flickr.com/photos/bookgrl/2388310523/\">Laura Taylor</a>\n    </p>\n    \n    <p><a href=\"http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html?&amp;show_reader_reports\" target=\"_blank\" rel=\"nofollow\">Signaler une erreur dans le texte</a></p>\n        \n</footer>    <section class=\"related-article\"><header><h3>Articles liés</h3>\n    </header><article class=\"post-grid format-article\"><a class=\"floatleft\" href=\"http://www.numerama.com/magazine/34444-firefox-prepare-l-enterrement-des-vieux-plugins.html\" title=\"Firefox prépare l'enterrement des vieux plugins\">\n        <div class=\"cover-preview cover-tech\">\n                            <p>Lire</p>\n            \n                            \n            \n            <img class=\"cover-preview_img\" src=\"http://c2.lestechnophiles.com/www.numerama.com/content/uploads/2015/10/cimetierecolleville.jpg?resize=200,135\" srcset=\"&#10;                    //c2.lestechnophiles.com/www.numerama.com/content/uploads/2015/10/cimetierecolleville.jpg?resize=200,135 200w,&#10;                                            //c2.lestechnophiles.com/www.numerama.com/content/uploads/2015/10/cimetierecolleville.jpg?resize=100,67 100w,&#10;                                        \" sizes=\"(min-width: 1001px) 200px, (max-width: 1000px) 100px\" alt=\"Firefox prépare l'enterrement des vieux plugins\"/></div>\n        <h4> Firefox prépare l'enterrement des vieux plugins </h4>\n    </a>\n    <footer class=\"span12\">\n    </footer></article><article class=\"post-grid format-article\"><a class=\"floatleft\" href=\"http://www.numerama.com/tech/131636-activer-navigation-privee-navigateur-web.html\" title=\"Comment activer la navigation privée sur son navigateur web\">\n        <div class=\"cover-preview cover-tech\">\n                            <p>Lire</p>\n            \n                            \n            \n            <img class=\"cover-preview_img\" src=\"http://c1.lestechnophiles.com/www.numerama.com/content/uploads/2015/11/Incognito.jpg?resize=200,135\" srcset=\"&#10;                    //c1.lestechnophiles.com/www.numerama.com/content/uploads/2015/11/Incognito.jpg?resize=200,135 200w,&#10;                                            //c1.lestechnophiles.com/www.numerama.com/content/uploads/2015/11/Incognito.jpg?resize=100,67 100w,&#10;                                        \" sizes=\"(min-width: 1001px) 200px, (max-width: 1000px) 100px\" alt=\"Comment activer la navigation privée sur son navigateur web\"/></div>\n        <h4> Comment activer la navigation privée sur son navigateur web </h4>\n    </a>\n    <footer class=\"span12\">\n    </footer></article><article class=\"post-grid format-article\"><a class=\"floatleft\" href=\"http://www.numerama.com/tech/144028-firefox-se-mettra-a-jour-regulierement.html\" title=\"Firefox se mettra à jour un peu moins régulièrement\">\n        <div class=\"cover-preview cover-tech\">\n                            <p>Lire</p>\n            \n                            \n            \n            <img class=\"cover-preview_img\" src=\"http://c0.lestechnophiles.com/www.numerama.com/content/uploads/2016/02/firefox-mobile.jpg?resize=200,135\" srcset=\"&#10;                    //c0.lestechnophiles.com/www.numerama.com/content/uploads/2016/02/firefox-mobile.jpg?resize=200,135 200w,&#10;                                            //c0.lestechnophiles.com/www.numerama.com/content/uploads/2016/02/firefox-mobile.jpg?resize=100,67 100w,&#10;                                        \" sizes=\"(min-width: 1001px) 200px, (max-width: 1000px) 100px\" alt=\"Firefox se mettra à jour un peu moins régulièrement\"/></div>\n        <h4> Firefox se mettra à jour un peu moins régulièrement </h4>\n    </a>\n    <footer class=\"span12\">\n    </footer></article>\n</section>\n",
+        "created_at": "2016-04-05T09:07:54+0000",
+        "domain_name": "www.numerama.com",
+        "is_archived": 0,
+        "is_starred": 0,
+        "language": "fr-FR",
+        "mimetype": "text/html",
+        "preview_picture": "http://www.numerama.com/content/uploads/2016/04/post-it.jpg",
+        "reading_time": 2,
+        "tags": [],
+        "title": "Le Pocket libre Wallabag fait le plein de fonctionnalités - Tech - Numerama",
+        "updated_at": "2016-04-05T09:07:54+0000",
+        "url": "http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html",
+        "user_email": "",
+        "user_id": 1,
+        "user_name": "wallabag"
+    }
+
+Et si vous voulez voir la liste des articles existants (voir **Récupérer les articles existants**), le tableau sera vide.
+
+Autres méthodes
+---------------
+
+Nous n'écrirons pas d'exemples pour toutes les méthodes de l'API.
+
+Jetez un œil à la liste complète ici http://localhost:8000/api/doc pour connaitre chaque méthode.
index 3a8d361a2c937e81e0cb30855f6ef6615ec2e0f8..628c62a5bfcec0ad567b104a65ae9e5ae1c2865d 100644 (file)
@@ -43,6 +43,7 @@ La documentation principale de cette application est découpée en plusieurs sec
    :maxdepth: 2
    :caption: Documentation développeur
 
+   developer/api
    developer/docker
    developer/translate
    developer/maintenance
index acf9fdc5e11f51c6fa6330585b5e189db22913a2..d19cf1bf8b5fcc5b89e8073a734242dd5aa49299 100644 (file)
@@ -338,6 +338,7 @@ developer:
     # documentation: 'Documentation'
     # how_to_first_app: 'How to create my first application'
     # full_documentation: 'View full API documentation'
+    # list_methods: 'List API methods'
     # clients:
     #     title: 'Clients'
     #     create_new: 'Create a new client'
index 02c998eae0bd89126f521bf26c330ef3d6763992..f1e7b6b8efdc5d9aadd86d2721304110f30da15a 100644 (file)
@@ -338,6 +338,7 @@ developer:
     documentation: 'Dokumentation'
     how_to_first_app: 'Wie erstelle ich meine erste Anwendung'
     full_documentation: 'Komplette API-Dokumentation einsehen'
+    # list_methods: 'List API methods'
     clients:
         title: 'Clients'
         create_new: 'Neuen Client erstellen'
index 2c3704f3aeaaf9cb27cca7ee243523c989429762..3dc229983ee9c94ebdae7e885e0c767280a4facd 100644 (file)
@@ -338,6 +338,7 @@ developer:
     documentation: 'Documentation'
     how_to_first_app: 'How to create my first application'
     full_documentation: 'View full API documentation'
+    list_methods: 'List API methods'
     clients:
         title: 'Clients'
         create_new: 'Create a new client'
index bcdad5b3354e50479175834f625c105aff0b5b3d..a8fcbcf66d0ed8a26681ac9aa4f54b1636c347ce 100644 (file)
@@ -338,6 +338,7 @@ developer:
     # documentation: 'Documentation'
     # how_to_first_app: 'How to create my first application'
     # full_documentation: 'View full API documentation'
+    # list_methods: 'List API methods'
     # clients:
     #     title: 'Clients'
     #     create_new: 'Create a new client'
index f753a91844dd93433c287ebe4cfcc3558b12a8d0..6be7d22ef15a6d62267c85523c71236131505db3 100644 (file)
@@ -338,6 +338,7 @@ developer:
     # documentation: 'Documentation'
     # how_to_first_app: 'How to create my first application'
     # full_documentation: 'View full API documentation'
+    # list_methods: 'List API methods'
     # clients:
     #     title: 'Clients'
     #     create_new: 'Create a new client'
index e5448ae32ab0ac845a1b919b673125016e5d9c8d..6ff1a3b1ad73cedafe95417cbb76fbad58c6378f 100644 (file)
@@ -338,6 +338,7 @@ developer:
     documentation: 'Documentation'
     how_to_first_app: 'Comment créer votre première application'
     full_documentation: "Voir la documentation complète de l'API"
+    list_methods: "Lister toutes les méthodes de l'API"
     clients:
         title: 'Clients'
         create_new: 'Créer une nouveau client'
index 7446fef9d95812502a0bc11802ff699cdef817c6..bbd813e2caca00d8c7c6f8e822c14af1308fb897 100644 (file)
@@ -338,6 +338,7 @@ developer:
     documentation: 'Documentacion'
     how_to_first_app: 'Cossí crear vòstra primièra aplicacion'
     full_documentation: "Veire la documentacion completa de l'API"
+    # list_methods: 'List API methods'
     clients:
         title: 'Clients'
         create_new: 'Crear un novèl client'
index 340a363439d6acb73373c27259ab1f493f394937..fb26de89f2e1740ea45a50b8e61ae3fcbf7521a0 100644 (file)
@@ -338,6 +338,7 @@ developer:
     documentation: 'Dokumentacja'
     how_to_first_app: 'Jak stworzyć moją pierwszą aplikację'
     full_documentation: 'Pokaż pełne API'
+    # list_methods: 'List API methods'
     clients:
          title: 'Klienci'
          create_new: 'Utwórz nowego klienta'
index 6dd3d56b5e892246e737b0cc619cea22fe8d8b41..bb817cb3f5231f03b0d3cd5aa981b1dceedd7e7c 100644 (file)
@@ -338,6 +338,7 @@ developer:
     # documentation: 'Documentation'
     # how_to_first_app: 'How to create my first application'
     # full_documentation: 'View full API documentation'
+    # list_methods: 'List API methods'
     # clients:
     #     title: 'Clients'
     #     create_new: 'Create a new client'
index 13e3558f2883f508bdf32f97639e231a10969590..897cc2f49999d02fbca45c0d334e4f454a605c4a 100644 (file)
@@ -338,6 +338,7 @@ developer:
     # documentation: 'Documentation'
     # how_to_first_app: 'How to create my first application'
     # full_documentation: 'View full API documentation'
+    # list_methods: 'List API methods'
     # clients:
     #     title: 'Clients'
     #     create_new: 'Create a new client'
index e12779b75370897cb2ad4d8486078e98e5a5999b..7ff64ca67e6c0b1fc5e42bcf874be22cfec9b5e4 100644 (file)
@@ -14,7 +14,8 @@
 
                 <ul>
                     <li><a href="{{ path('developer_howto_firstapp') }}">{{ 'developer.how_to_first_app'|trans }}</a></li>
-                    <li><a href="{{ path('nelmio_api_doc_index') }}">{{ 'developer.full_documentation'|trans }}</a></li>
+                    <li><a href="http://doc.wallabag.org/en/v2-documentation-api/developer/api.html">{{ 'developer.full_documentation'|trans }}</a></li>
+                    <li><a href="{{ path('nelmio_api_doc_index') }}">{{ 'developer.list_methods'|trans }}</a></li>
                 </ul>
 
                 <h4>{{ 'developer.clients.title'|trans }}</h4>
index e12779b75370897cb2ad4d8486078e98e5a5999b..7ff64ca67e6c0b1fc5e42bcf874be22cfec9b5e4 100644 (file)
@@ -14,7 +14,8 @@
 
                 <ul>
                     <li><a href="{{ path('developer_howto_firstapp') }}">{{ 'developer.how_to_first_app'|trans }}</a></li>
-                    <li><a href="{{ path('nelmio_api_doc_index') }}">{{ 'developer.full_documentation'|trans }}</a></li>
+                    <li><a href="http://doc.wallabag.org/en/v2-documentation-api/developer/api.html">{{ 'developer.full_documentation'|trans }}</a></li>
+                    <li><a href="{{ path('nelmio_api_doc_index') }}">{{ 'developer.list_methods'|trans }}</a></li>
                 </ul>
 
                 <h4>{{ 'developer.clients.title'|trans }}</h4>