Move files into api/ dir

diff --git a/.gitignore b/.gitignore
index daa30a3f752706bce3bc36b34a7aab39ee5484d4..8b9d7e110e6832d8e9c6645efbcd102645e81004 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -1 +1,2 @@
-README.html
+*.htm
+*.html

diff --git a/README.rst b/README.rst
index c326848b78ccc93326f3d30f663e11c95c8105e4..a60d16a11ad98258dcef55f3213410be53797b4d 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -5,13 +5,21 @@ Tolino cloud API documentation
 Servers the Tolino Vision 3/4 HD talk to (Firmware 14.x).
 
 .. contents::
-   :depth: 1
+   :depth: 2
 
-.. include:: headers.rst
-.. include:: domains.rst
-.. include:: login.rst
-.. include:: pageplace.bosh-bosh-rest-ping.rst
-.. include:: pageplace.bosh-bosh-rest-userid-xxx.rst
-.. include:: pageplace.bosh-bosh-rest-v2-resellerconfig.rst
-.. include:: thalia-auth-oauth2-authorize.rst
-.. include:: thalia-auth-oauth2-token-post.rst
+General information
+*******************
+.. include:: api/headers.rst
+.. include:: api/domains.rst
+
+Use cases
+*********
+.. include:: api/usecase-login.rst
+
+API calls
+*********
+.. include:: api/pageplace.bosh-bosh-rest-ping.rst
+.. include:: api/pageplace.bosh-bosh-rest-userid-xxx.rst
+.. include:: api/pageplace.bosh-bosh-rest-v2-resellerconfig.rst
+.. include:: api/thalia-auth-oauth2-authorize.rst
+.. include:: api/thalia-auth-oauth2-token-post.rst

diff --git a/domains.rst b/api/domains.rst
similarity index 100%
rename from domains.rst
rename to api/domains.rst

diff --git a/headers.rst b/api/headers.rst
similarity index 100%
rename from headers.rst
rename to api/headers.rst

diff --git a/pageplace.bosh-bosh-rest-ping.rst b/api/pageplace.bosh-bosh-rest-ping.rst
similarity index 100%
rename from pageplace.bosh-bosh-rest-ping.rst
rename to api/pageplace.bosh-bosh-rest-ping.rst

diff --git a/pageplace.bosh-bosh-rest-userid-xxx.response.json b/api/pageplace.bosh-bosh-rest-userid-xxx.response.json
similarity index 100%
rename from pageplace.bosh-bosh-rest-userid-xxx.response.json
rename to api/pageplace.bosh-bosh-rest-userid-xxx.response.json

diff --git a/pageplace.bosh-bosh-rest-userid-xxx.rst b/api/pageplace.bosh-bosh-rest-userid-xxx.rst
similarity index 80%
rename from pageplace.bosh-bosh-rest-userid-xxx.rst
rename to api/pageplace.bosh-bosh-rest-userid-xxx.rst
index e907e1e64d0ac5ac80ce924203e61fdfb749fe77..36f39084f8f8771796a14cbd38f06d1535aa9837 100644 (file)
--- a/pageplace.bosh-bosh-rest-userid-xxx.rst
+++ b/api/pageplace.bosh-bosh-rest-userid-xxx.rst
@@ -3,15 +3,12 @@
 ======================================================
 Step 5 in the `Login process`_.
 
-Example ``xxx`` value: ``665fc389ef4e47258c5db9fa7821bd19``.
-
-FIXME: What is the ``xxx`` value? Hardware ID? User ID?
-If yes, where does the server know it from?
+Check if the device has been registered already to a user. (? FIXME)
 
-FIXME: Find out how to transform the ``x_buchde.user_id`` from
-`POST https://thalia.de/auth/oauth2/token`_ into that user ID here,
-and if it is really the same.
+Example ``xxx`` value: ``665fc389ef4e47258c5db9fa7821bd19``.
 
+There is some explanation about the hardware id in
+`tolino-python: tolinocloud.py <https://github.com/hzulla/tolino-python/blob/c655dbcd1b23e3874fd7dc78736570ac27ff5123/tolinocloud.py#L42>`_.
 
 Request
 =======

diff --git a/pageplace.bosh-bosh-rest-v2-resellerconfig.response-ok.json b/api/pageplace.bosh-bosh-rest-v2-resellerconfig.response-ok.json
similarity index 100%
rename from pageplace.bosh-bosh-rest-v2-resellerconfig.response-ok.json
rename to api/pageplace.bosh-bosh-rest-v2-resellerconfig.response-ok.json

diff --git a/pageplace.bosh-bosh-rest-v2-resellerconfig.rst b/api/pageplace.bosh-bosh-rest-v2-resellerconfig.rst
similarity index 100%
rename from pageplace.bosh-bosh-rest-v2-resellerconfig.rst
rename to api/pageplace.bosh-bosh-rest-v2-resellerconfig.rst

diff --git a/thalia-auth-oauth2-authorize.rst b/api/thalia-auth-oauth2-authorize.rst
similarity index 100%
rename from thalia-auth-oauth2-authorize.rst
rename to api/thalia-auth-oauth2-authorize.rst

diff --git a/thalia-auth-oauth2-token-post.response.json b/api/thalia-auth-oauth2-token-post.response.json
similarity index 100%
rename from thalia-auth-oauth2-token-post.response.json
rename to api/thalia-auth-oauth2-token-post.response.json

diff --git a/thalia-auth-oauth2-token-post.rst b/api/thalia-auth-oauth2-token-post.rst
similarity index 100%
rename from thalia-auth-oauth2-token-post.rst
rename to api/thalia-auth-oauth2-token-post.rst

diff --git a/login.rst b/api/usecase-login.rst
similarity index 100%
rename from login.rst
rename to api/usecase-login.rst

diff --git a/pageplace.bosh-bosh-rest-v2-resellerconfig.html b/pageplace.bosh-bosh-rest-v2-resellerconfig.html
deleted file mode 100644 (file)
index b1f8281..0000000
--- a/pageplace.bosh-bosh-rest-v2-resellerconfig.html
+++ /dev/null
@@ -1,44 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-    <title>GET https://bosh.pageplace.de/bosh/rest/v2/resellerconfig</title>
-    <meta charset="utf-8" />
-</head>
-<body>
-    <section id="get-https-bosh-pageplace-de-bosh-rest-v2-resellerconfig">
-        <h1><code>GET https://bosh.pageplace.de/bosh/rest/v2/resellerconfig</code></h1>
-        <section id="request">
-            <h2>Request</h2>
-            <dl>
-                <dt>Header</dt>
-                <dd>
-                    <dl>
-                        <dt><code>ifmodifiedsince</code></dt>
-                        <dd>Example: <code>1603111725000</code></dd>
-                        <dt><code>reseller_id</code></dt>
-                        <dd>Example: <code>3</code></dd>
-                        <dt><code>hardware_type</code></dt>
-                        <dd>Example: <code>tolino_vision_3</code></dd>
-                        <dt><code>os_version</code></dt>
-                        <dd>Android version Example: <code>4.4.2</code></dd>
-                        <dt><code>language_code</code></dt>
-                        <dd>Example: <code>en</code></dd>
-                        <dt><code>hardware_id</code></dt>
-                        <dd>Example: <code>665fd389ea4e47228c5db8fa7821bd23</code></dd>
-                        <dt><code>client_type</code></dt>
-                        <dd>Example: <code>TOLINO_VISION_3</code></dd>
-                        <dt><code>client_version</code></dt>
-                        <dd>
-                            <p>Tolino firmware version</p>
-                            <p>Example: <code>14.1.0</code></p>
-                        </dd>
-                    </dl>
-                </dd>
-            </dl>
-        </section>
-        <section id="response">
-            <h2>Response</h2>
-        </section>
-    </section>
-</body>
-</html>
\ No newline at end of file

diff --git a/thalia-auth-oauth2-token-post.html b/thalia-auth-oauth2-token-post.html
deleted file mode 100644 (file)
index 4f50a8c..0000000
--- a/thalia-auth-oauth2-token-post.html
+++ /dev/null
@@ -1,88 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-    <title>POST https://thalia.de/auth/oauth2/token</title>
-    <meta charset="utf-8" />
-</head>
-<body>
-    <section id="post-https-thalia-de-auth-oauth2-token">
-        <h1><code>POST https://thalia.de/auth/oauth2/token</code></h1>
-        <ol type="1">
-            <li>Log in to obtain an access token.</li>
-            <li>Generate access token from a refresh token.</li>
-        </ol>
-        <p>Step 4 of the <a id="id2" class="problematic" href="#id1">`Login process`_</a>.</p>
-        <section id="source">
-            <h2>Source</h2>
-            <p>This URL is provided in the reseller configuration, key <code>config.URL_OAUTH_ACCESSTOKEN</code>.</p>
-        </section>
-        <section id="request">
-            <h2>Request</h2>
-            <dl>
-                <dt>GET parameters</dt>
-                <dd>
-                    <dl>
-                        <dt><code>client_secret</code></dt>
-                        <dd>
-                            <p>Provided in the reseller configuration.</p>
-                            <p>Example: <code>gU5a7CA9</code></p>
-                        </dd>
-                    </dl>
-                </dd>
-                <dt>Headers</dt>
-                <dd>
-                    <dl>
-                        <dt><code>Content-Type</code></dt>
-                        <dd><code>application/x-www-form-urlencoded</code></dd>
-                        <dt><code>User-Agent</code></dt>
-                        <dd><code>DT_EINK_10_NETRONIX DT_EINK_UPD_PP_14.1.0</code></dd>
-                        <dt><code>Cookie</code>:</dt>
-                        <dd>Example: <code>gcor=SIDYBbxYkmvUvoO8hy@2Sfx4QAAA9o; ab_bucket=9; ab_container=3; OAUTH-JSESSIONID=9C95C20ECEE74164E76F60C205147822.15acdb90</code></dd>
-                        <dt><code>Cookie2</code></dt>
-                        <dd><code>$Version=1</code></dd>
-                    </dl>
-                </dd>
-                <dt>POST parameters</dt>
-                <dd>
-                    <dl>
-                        <dt><code>grant_type</code>:</dt>
-                        <dd><code>authorization_code</code></dd>
-                        <dt><code>redirect_uri</code></dt>
-                        <dd>
-                            <p><code>epublishing://login</code></p>
-                            <p>The e-reader internal login process</p>
-                        </dd>
-                        <dt><code>code</code></dt>
-                        <dd>
-                            <p>Obtained from login form page redirect.</p>
-                            <p>Example: <code>GK6jDC</code></p>
-                        </dd>
-                        <dt><code>client_id</code></dt>
-                        <dd>Example: <code>treadervision3</code></dd>
-                    </dl>
-                </dd>
-            </dl>
-        </section>
-        <section id="response">
-            <h2>Response</h2>
-            <p>HTTP status code <code>200 OK</code></p>
-            <pre class="code" source="thalia-auth-oauth2-token-post.response.json">{
-    "access_token": "eyJhbGciOiJSUzI1NiJ9.eyJhdWRpZW5jZSI6InRyZWFkZXJ2aXNpb24zIiwiZXhwaXJlcyI6IjE2MTIxMzgzOTczMzMiLCJ4X2J1Y2hkZS51c2VyX2lk...",
-    "expires_in": 14399,
-    "refresh_token": "ad351547-bcb3-43b2-9914-d88f0a3704c8",
-    "scope": "FAMILY SCOPE_BOSH SCOPE_BUCHDE SCOPE_LOGIN",
-    "token_type": "bearer",
-    "x_buchde.mandant_id": "2004",
-    "x_buchde.user_id": "39549013"
-}</pre>
-        </section>
-    </section>
-    <section class="system-messages">
-        <h1>Docutils System Messages</h1>
-        <div id="id1">
-            <h1>System Message: ERROR/3 (thalia-auth-oauth2-token-post.rst line 7) <a href="#id2">id2</a></h1>
-            <p>Unknown target name: "login process".</p>
-        </div>
-    </section>
-</body>
-</html>
\ No newline at end of file