Doc: Added examples

k4ever/docs/django/api.rst

@@ -169,6 +169,36 @@ Decorators
 
 Examples
 --------
- - how to use the api
+Here are some code examples how to use the API with different clients or languages.
- - examples with... wget.. python-rest?
+In these examples we have for authentication *frundy*/*foobar* as a normal user and *testplugin*/*maunz* as a plugin.
 
+
+WGET
+""""
+``wget`` comes in handy at this task. At some point it might be that ``wget`` cannot provide full access to the API cause it is unable to send ``PUT`` and ``DELETE`` requests. For debugging purposes the flags `-Sd` are recommended.
+
+.. code-block:: bash
+
+    # find item with barcode
+	wget -qS -O- --auth-no-challenge --http-user=frundy --http-password=foobar http://server/api/buyable/item/?barcode=4029764001807
+	# buy 10 times item with id 3
+	wget -qS -O- --auth-no-challenge --http-user=frundy --http-password=foobar http://server/api/buyable/item/3/ --post-data "amount=10"
+	# as plugin get users account balance
+	wget -qS -O- --auth-no-challenge --http-user=testplugin --http-password=maunz http://server/api/buyable/account/balance/?user=frundy
+	# as plugin buy 10 times item with id 3
+	wget -qS -O- --auth-no-challenge --http-user=testplugin --http-password=maunz http://server/api/buyable/item/3/ --post-data "amount=10&user=frundy
+
+CURL
+""""
+As one might see, ``curl`` is quite nice for accessing the API. ``curl`` also supports the ``HTTP``, ``PUT`` and ``DELETE`` methods.
+
+.. code-block:: bash
+
+    # find item with barcode
+	curl --basic http://frundy:foobar@server/api/buyable/item/?barcode=4029764001807
+	# buy 10 times item with id 3
+	curl --basic -X POST --data "amount=10" http://fruny:foobar@server/api/buyable/item/3/
+	# as plugin get users account balance
+	curl --basic http://testplugin:maunz@server/api/buyable/account/balance/?user=frundy
+	# as plugin buy 10 times item with id 3
+	curl --basic -X POST --data "amount=10" http://testplugin:maunz@server/api/buyable/item/3/?user=frundy