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