X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=docs%2Fen%2Fdeveloper%2Fapi.rst;h=d61591f488e81b4a51b2a74bbd505c4e1ad64f4f;hb=a40b2b7ee4f5aec502c4ddc755ed7d15f9b7a756;hp=38f0377c35e835c5d225350e2e21bcce02383e53;hpb=7d5b4631d0b297b1e29d3cd541a61a1d78b5b999;p=github%2Fwallabag%2Fwallabag.git diff --git a/docs/en/developer/api.rst b/docs/en/developer/api.rst index 38f0377c..d61591f4 100644 --- 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 `__). 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 `_ Creating a new API client ------------------------- @@ -69,7 +69,7 @@ You'll have this in return: We'll work with the ``access_token`` value in our next calls. -Curl example: +cURL example: :: @@ -126,7 +126,7 @@ returns: The ``items`` array is empty. -Curl example: +cURL example: :: @@ -186,7 +186,7 @@ returns Now, if you execute the previous command (see **Get existing entries**), you'll have data. -Curl example: +cURL example: :: @@ -245,7 +245,7 @@ returns And if you want to list the existing entries (see **Get existing entries**), the array is empty. -Curl example: +cURL example: :: @@ -257,3 +257,14 @@ 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 `_ by Strubbl. +- `.NET library for the wallabag v2 API `_ by Julian Oster. +- `Python API for wallabag `_ by FoxMaSk, for his project `Trigger Happy `_. +- `A plugin `_ designed for `Tiny Tiny RSS `_ that makes use of the wallabag v2 API. By Josh Panter. +- `Golang wrapper for the wallabag API `_ by Strubbl, for his project `wallabag-stats graph`_.