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