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