README.rst

   1 ******************************
   2 Tolino cloud API documentation
   3 ******************************
   4
   5 Servers the Tolino Vision 3/4 HD talk to (Firmware 14.x).
   6
   7 .. contents::
   8    :depth: 2
   9
  10
  11 General information
  12 *******************
  13 .. include:: api/headers.rst
  14 .. include:: api/domains.rst
  15
  16
  17 Use cases
  18 *********
  19 .. include:: api/usecase-login.rst
  20 .. include:: api/usecase-sync.rst
  21
  22
  23 API calls
  24 *********
  25 .. include:: api/pageplace.bosh-bosh-rest-inventory-count.rst
  26 .. include:: api/pageplace.bosh-bosh-rest-ping.rst
  27 .. include:: api/pageplace.bosh-bosh-rest-userid-xxx.rst
  28 .. include:: api/pageplace.bosh-bosh-rest-v2-registerhw.rst
  29 .. include:: api/pageplace.bosh-bosh-rest-v2-resellerconfig.rst
  30 .. include:: api/pageplace.inventory-v2-inventory.rst
  31 .. include:: api/thalia-auth-oauth2-authorize.rst
  32 .. include:: api/thalia-auth-oauth2-token-post.rst
  33
  34
  35 About
  36 *****
  37 This documentation has been written by Christian Weiske,
  38 cweiske+tolino@cweiske.de.
  39
  40 Last update: ##UPDATE##
  41
  42
  43 =======
  44 License
  45 =======
  46 It is licensed under the GNU Free Documentation License.
  47
  48
  49 ===========
  50 Source code
  51 ===========
  52 The documentation sources are available at
  53 http://git.cweiske.de/tolino-api-docs.git/
  54 and mirrored at
  55 https://github.com/cweiske/tolino-api-docs
  56
  57
  58 =========
  59 Home page
  60 =========
  61 A rendered version of this documentation is available at
  62 http://cweiske.de/tolino-api-docs.htm
  63
  64
  65 ========
  66 Building
  67 ========
  68 You need to install ``rst2html5`` before (the version with bootstrap CSS)::
  69
  70     $ pip3 install rst2html5-tools
  71
  72 Rendering the docs is done via the Makefile::
  73
  74     $ make