docs: update 3rd party projects by Strubbl

[github/wallabag/wallabag.git] / docs / en / developer / api.rst

diff --git a/docs/en/developer/api.rst b/docs/en/developer/api.rst
index ac00d3a449847b61803c210b9f2b4ef9aae7eb94..d61591f488e81b4a51b2a74bbd505c4e1ad64f4f 100644 (file)
--- a/docs/en/developer/api.rst
+++ b/docs/en/developer/api.rst
@@ -8,7 +8,7 @@ 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
+* all the API methods are documented here http://localhost:8000/api/doc (on your instance) and `on our example instance <http://v2.wallabag.org/api/doc>`_ 
 
 Creating a new API client
 -------------------------
@@ -69,6 +69,12 @@ You'll have this in return:
 
 We'll work with the ``access_token`` value in our next calls.
 
+cURL example:
+
+::
+
+    curl -s "https://localhost:8000/oauth/v2/token?grant_type=password&client_id=1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc&client_secret=636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4&username=wallabag&password=wallabag"
+
 Getting existing entries
 ------------------------
 
@@ -120,6 +126,12 @@ returns:
 
 The ``items`` array is empty.
 
+cURL example:
+
+::
+
+    curl --get "https://localhost:8000/api/entries.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA"
+
 Adding your first entry
 -----------------------
 
@@ -174,6 +186,12 @@ returns
 
 Now, if you execute the previous command (see **Get existing entries**), you'll have data.
 
+cURL example:
+
+::
+
+    curl "https://localhost:8000/api/entries.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA&url=http://www.numerama.com/tech/160115-le-pocket-libre-wallabag-fait-le-plein-de-fonctionnalites.html"
+
 Deleting an entry
 -----------------
 
@@ -227,9 +245,26 @@ returns
 
 And if you want to list the existing entries (see **Get existing entries**), the array is empty.
 
+cURL example:
+
+::
+
+    curl --request DELETE "https://localhost:8000/api/entries/1.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA"
+
 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.
+
+Third party resources
+---------------
+
+Some applications or libraries use our API. Here is a non-exhaustive list of them:
+
+- `Java wrapper for the wallabag API <https://github.com/Strubbl/jWallabag>`_ by Strubbl.
+- `.NET library for the wallabag v2 API <https://github.com/jlnostr/wallabag-api>`_ by Julian Oster.
+- `Python API for wallabag <https://github.com/foxmask/wallabag_api>`_ by FoxMaSk, for his project `Trigger Happy <https://blog.trigger-happy.eu/>`_.
+- `A plugin <https://github.com/joshp23/ttrss-to-wallabag-v2>`_ designed for `Tiny Tiny RSS <https://tt-rss.org/gitlab/fox/tt-rss/wikis/home>`_ that makes use of the wallabag v2 API. By Josh Panter.
+- `Golang wrapper for the wallabag API <https://github.com/Strubbl/wallabago>`_ by Strubbl, for his project `wallabag-stats graph<https://github.com/Strubbl/wallabag-stats>`_.