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-handshake-resellers.rst
  28 .. include:: api/pageplace.bosh-bosh-rest-inventory-count.rst
  29 .. include:: api/pageplace.bosh-bosh-rest-ping.rst
  30 .. include:: api/pageplace.bosh-bosh-rest-recommendation-xyz.rst
  31 .. include:: api/pageplace.bosh-bosh-rest-sync-data.rst
  32 .. include:: api/pageplace.bosh-bosh-rest-time.rst
  33 .. include:: api/pageplace.bosh-bosh-rest-userid-xxx.rst
  34 .. include:: api/pageplace.bosh-bosh-rest-v2-registerhw.rst
  35 .. include:: api/pageplace.bosh-bosh-rest-v2-resellerconfig.rst
  36 .. include:: api/pageplace.inventory-v2-inventory.rst
  37 .. include:: api/thalia-auth-oauth2-authorize.rst
  38 .. include:: api/thalia-auth-oauth2-token-post.rst
  39
  40
  41 About
  42 *****
  43 This documentation has been written by Christian Weiske,
  44 cweiske+tolino@cweiske.de.
  45
  46 Last update: ##UPDATE##
  47
  48
  49 =======
  50 License
  51 =======
  52 It is licensed under the GNU Free Documentation License.
  53
  54
  55 ===========
  56 Source code
  57 ===========
  58 The documentation sources are available at
  59 http://git.cweiske.de/tolino-api-docs.git/
  60 and mirrored at
  61 https://github.com/cweiske/tolino-api-docs
  62
  63
  64 =========
  65 Home page
  66 =========
  67 A rendered version of this documentation is available at
  68 http://cweiske.de/tolino-api-docs.htm
  69
  70
  71 ========
  72 Building
  73 ========
  74 You need to install ``rst2html5`` before (the version with bootstrap CSS)::
  75
  76     $ pip3 install rst2html5-tools
  77
  78 Rendering the docs is done via the Makefile::
  79
  80     $ make