mirror of
https://github.com/ovh/python-ovh.git
synced 2026-01-16 23:00:21 +00:00
add advanced usage documentation
Signed-off-by: Jean-Tiare Le Bigot <jean-tiare.le-bigot@corp.ovh.com>
This commit is contained in:
parent
bd15b2d73e
commit
328282900d
3 changed files with 58 additions and 1 deletions
28
README.rst
28
README.rst
|
|
@ -453,6 +453,34 @@ With characters invalid in python argument name like a dot, you can:
|
|||
# pass parameters using **
|
||||
client.post('/me/bills', **params)
|
||||
|
||||
Advanced usage
|
||||
==============
|
||||
|
||||
Un-authenticated calls
|
||||
----------------------
|
||||
|
||||
If the user has not authenticated yet (ie, there is no valid Consumer Key), you
|
||||
may force ``python-ovh`` to issue the call by passing ``_need_auth=True`` to
|
||||
the high level ``get()``, ``post()``, ``put()`` and ``delete()`` helpers or
|
||||
``need_auth=True`` to the low level method ``Client.call()`` and
|
||||
``Client.raw_call()``.
|
||||
|
||||
This is needed when calling ``POST /auth/credential`` and ``GET /auth/time``
|
||||
which are used internally for authentication and can optionally be done for
|
||||
most of the ``/order`` calls.
|
||||
|
||||
Access the raw requests response objects
|
||||
----------------------------------------
|
||||
|
||||
The high level ``get()``, ``post()``, ``put()`` and ``delete()`` helpers as well
|
||||
as the lower level ``call()`` will returned a parsed json response or raise in
|
||||
case of error.
|
||||
|
||||
In some rare scenario, advanced setups, you may need to perform customer
|
||||
processing on the raw request response. It may be accessed via ``raw_call()``.
|
||||
This is the lowest level call in ``python-ovh``. See the source for more
|
||||
informations.
|
||||
|
||||
Hacking
|
||||
=======
|
||||
|
||||
|
|
|
|||
|
|
@ -352,6 +352,34 @@ With characters invalid in python argument name like a dot, you can:
|
|||
# pass parameters using **
|
||||
client.post('/me/bills', **params)
|
||||
|
||||
Advanced usage
|
||||
==============
|
||||
|
||||
Un-authenticated calls
|
||||
----------------------
|
||||
|
||||
If the user has not authenticated yet (ie, there is no valid Consumer Key), you
|
||||
may force ``python-ovh`` to issue the call by passing ``_need_auth=True`` to
|
||||
the high level ``get()``, ``post()``, ``put()`` and ``delete()`` helpers or
|
||||
``need_auth=True`` to the low level method ``Client.call()`` and
|
||||
``Client.raw_call()``.
|
||||
|
||||
This is needed when calling ``POST /auth/credential`` and ``GET /auth/time``
|
||||
which are used internally for authentication and can optionally be done for
|
||||
most of the ``/order`` calls.
|
||||
|
||||
Access the raw requests response objects
|
||||
----------------------------------------
|
||||
|
||||
The high level ``get()``, ``post()``, ``put()`` and ``delete()`` helpers as well
|
||||
as the lower level ``call()`` will returned a parsed json response or raise in
|
||||
case of error.
|
||||
|
||||
In some rare scenario, advanced setups, you may need to perform customer
|
||||
processing on the raw request response. It may be accessed via ``raw_call()``.
|
||||
This is the lowest level call in ``python-ovh``. See the source for more
|
||||
informations.
|
||||
|
||||
Hacking
|
||||
=======
|
||||
|
||||
|
|
|
|||
|
|
@ -454,7 +454,8 @@ class Client(object):
|
|||
"""
|
||||
Lowest level call helper. If ``consumer_key`` is not ``None``, inject
|
||||
authentication headers and sign the request.
|
||||
Will return a vendored ``requests.Response`` object or let any ``requests`` exception pass through.
|
||||
Will return a vendored ``requests.Response`` object or let any
|
||||
``requests`` exception pass through.
|
||||
|
||||
Request signature is a sha1 hash on following fields, joined by '+'
|
||||
- application_secret
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue