diff options
author | Dirk Deimeke <dirk@deimeke.net> | 2016-04-19 08:00:07 +0200 |
---|---|---|
committer | Dirk Deimeke <dirk@deimeke.net> | 2016-04-19 08:00:07 +0200 |
commit | 938a16c0f6d68da3cffc53916b4529d100216e3a (patch) | |
tree | 8ef58710dcd862858f6a2f75766dccecda1fccf2 /docs/en | |
parent | ca8d61b95879314e25aa87c11b5bbfd0df7adb91 (diff) | |
download | wallabag-938a16c0f6d68da3cffc53916b4529d100216e3a.tar.gz wallabag-938a16c0f6d68da3cffc53916b4529d100216e3a.tar.zst wallabag-938a16c0f6d68da3cffc53916b4529d100216e3a.zip |
Added some curl examples
Diffstat (limited to 'docs/en')
-rw-r--r-- | docs/en/developer/api.rst | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/en/developer/api.rst b/docs/en/developer/api.rst index ac00d3a4..38f0377c 100644 --- a/docs/en/developer/api.rst +++ b/docs/en/developer/api.rst | |||
@@ -69,6 +69,12 @@ You'll have this in return: | |||
69 | 69 | ||
70 | We'll work with the ``access_token`` value in our next calls. | 70 | We'll work with the ``access_token`` value in our next calls. |
71 | 71 | ||
72 | Curl example: | ||
73 | |||
74 | :: | ||
75 | |||
76 | curl -s "https://localhost:8000/oauth/v2/token?grant_type=password&client_id=1_3o53gl30vhgk0c8ks4cocww08o84448osgo40wgw4gwkoo8skc&client_secret=636ocbqo978ckw0gsw4gcwwocg8044sco0w8w84cws48ggogs4&username=wallabag&password=wallabag" | ||
77 | |||
72 | Getting existing entries | 78 | Getting existing entries |
73 | ------------------------ | 79 | ------------------------ |
74 | 80 | ||
@@ -120,6 +126,12 @@ returns: | |||
120 | 126 | ||
121 | The ``items`` array is empty. | 127 | The ``items`` array is empty. |
122 | 128 | ||
129 | Curl example: | ||
130 | |||
131 | :: | ||
132 | |||
133 | curl --get "https://localhost:8000/api/entries.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" | ||
134 | |||
123 | Adding your first entry | 135 | Adding your first entry |
124 | ----------------------- | 136 | ----------------------- |
125 | 137 | ||
@@ -174,6 +186,12 @@ returns | |||
174 | 186 | ||
175 | Now, if you execute the previous command (see **Get existing entries**), you'll have data. | 187 | Now, if you execute the previous command (see **Get existing entries**), you'll have data. |
176 | 188 | ||
189 | Curl example: | ||
190 | |||
191 | :: | ||
192 | |||
193 | 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" | ||
194 | |||
177 | Deleting an entry | 195 | Deleting an entry |
178 | ----------------- | 196 | ----------------- |
179 | 197 | ||
@@ -227,6 +245,12 @@ returns | |||
227 | 245 | ||
228 | And if you want to list the existing entries (see **Get existing entries**), the array is empty. | 246 | And if you want to list the existing entries (see **Get existing entries**), the array is empty. |
229 | 247 | ||
248 | Curl example: | ||
249 | |||
250 | :: | ||
251 | |||
252 | curl --request DELETE "https://localhost:8000/api/entries/1.html?access_token=ZGJmNTA2MDdmYTdmNWFiZjcxOWY3MWYyYzkyZDdlNWIzOTU4NWY3NTU1MDFjOTdhMTk2MGI3YjY1ZmI2NzM5MA" | ||
253 | |||
230 | Other methods | 254 | Other methods |
231 | ------------- | 255 | ------------- |
232 | 256 | ||