diff options
| author |  RaNaN <Mast3rRaNaN@hotmail.de>
| 2013-06-09 18:10:22 +0200 |
|---|---|---|
| committer | RaNaN <Mast3rRaNaN@hotmail.de>
| 2013-06-09 18:10:23 +0200 |
| commit | 16af85004c84d0d6c626b4f8424ce9647669a0c1 (patch) | |
| tree | 025d479862d376dbc17e934f4ed20031c8cd97d1 /docs/api/json_api.rst | |
| parent | adapted to jshint config (diff) | |
| download | pyload-16af85004c84d0d6c626b4f8424ce9647669a0c1.tar.xz | |
moved everything from module to pyload
Diffstat (limited to 'docs/api/json_api.rst')
| -rw-r--r-- | docs/api/json_api.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/api/json_api.rst b/docs/api/json_api.rst index 1f54e40aa..504de20bf 100644 --- a/docs/api/json_api.rst +++ b/docs/api/json_api.rst @@ -6,7 +6,7 @@ JSON API JSON [1]_ is a lightweight object notation and wrappers exists for nearly every programming language. Every modern browser is able to load JSON objects with JavaScript. Unlike other RPC methods you don't need to generate or precompile -any stub methods. The JSON :class:`Api <module.Api.Api>` is ready to be used in most languages and most JSON libraries are lightweight +any stub methods. The JSON :class:`Api <pyload.Api.Api>` is ready to be used in most languages and most JSON libraries are lightweight enough to build very small and performant scripts. Because of the builtin support, JSON is the first choice for all browser applications. @@ -28,7 +28,7 @@ so pyLoad can authenticate you. Calling Methods --------------- -In general you can use any method listed at the :class:`Api <module.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 thrift backend. Access works simply via ``http://pyload-core/api/methodName``, where ``pyload-core`` is the ip address @@ -43,7 +43,7 @@ Passing parameters To pass arguments you have two choices: Either use positional arguments, e.g.: ``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 <module.Api.Api>` documentation. +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 1 represents an integer in json format. On the other hand if the method is expecting strings, this would be correct: |