diff options
| author |  Walter Purcaro <vuolter@users.noreply.github.com>
| 2015-05-12 03:15:13 +0200 |
|---|---|---|
| committer | Walter Purcaro <vuolter@users.noreply.github.com>
| 2015-05-12 03:22:42 +0200 |
| commit | 6f48bf541b7b0eeb0c6968ca63125bf73e016643 (patch) | |
| tree | a16b7fa193c2067f190c4f8aaa21ff2c3eec2c1c /docs/access_api.rst | |
| parent | 'from time' -> 'import time' and so on... (2) (diff) | |
| download | pyload-6f48bf541b7b0eeb0c6968ca63125bf73e016643.tar.xz | |
Fix some directory names
Diffstat (limited to 'docs/access_api.rst')
| -rw-r--r-- | docs/access_api.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/access_api.rst b/docs/access_api.rst index 938b73d04..1e19ea71b 100644 --- a/docs/access_api.rst +++ b/docs/access_api.rst @@ -13,12 +13,12 @@ First of all, you need to know what you can do with our API. It lets you do all retrieving download status, manage queue, manage accounts, modify config and so on. This document is not intended to explain every function in detail, for a complete listing -see :class:`Api <pyload.api.Api>`. +see :class:`Api <pyload.Api.Api>`. Of course its possible to access the ``core.api`` attribute in plugins and addons, but much more interesting is the possibillity to call function from different programs written in many different languages. -pyLoad uses thrift as backend and provides its :class:`Api <pyload.api.Api>` as service. +pyLoad uses thrift as backend and provides its :class:`Api <pyload.Api.Api>` as service. More information about thrift can be found here http://wiki.apache.org/thrift/. @@ -92,7 +92,7 @@ so pyLoad can authenticate you. Calling Methods =============== -In general you can use any method listed at the :class:`Api <pyload.api.Api>` documentation, which is also available to +In general you can use any method listed at the :class:`Api <pyload.Api.Api>` documentation, which is also available to the thriftbackend. Access works simply via ``http://pyload-core/api/methodName``, where ``pyload-core`` is the ip address @@ -107,7 +107,7 @@ Passing parameters To pass arguments you have two choices. Either use positional arguments, eg ``http://pyload-core/api/getFileData/1``, where 1 is the FileID, or use keyword arguments -supplied via GET or POST ``http://pyload-core/api/getFileData?fid=1``. You can find the argument names in the :class:`Api <pyload.api.Api>` +supplied via GET or POST ``http://pyload-core/api/getFileData?fid=1``. You can find the argument names in the :class:`Api <pyload.Api.Api>` documentation. It is important that *all* arguments are in JSON format. So ``http://pyload-core/api/getFileData/1`` is valid because |