more v2
authorChristian Weiske <cweiske@cweiske.de>
Wed, 6 Apr 2022 21:04:38 +0000 (23:04 +0200)
committerChristian Weiske <cweiske@cweiske.de>
Wed, 6 Apr 2022 21:04:38 +0000 (23:04 +0200)
README.rst
api/headers.rst
api/internal-urls.rst
api/pageplace.bosh-bosh-rest-recommendation-xyz.rst
api/pageplace.bosh-bosh-rest-v2-registerhw.rst
api/pageplace.bosh-bosh-rest-v2-resellerconfig.rst
api/pageplace.bosh-bosh-rest-v2-versioncheck.request.json [new file with mode: 0644]
api/pageplace.bosh-bosh-rest-v2-versioncheck.response-noupdate.json [new file with mode: 0644]
api/pageplace.bosh-bosh-rest-v2-versioncheck.response-update.json [new file with mode: 0644]
api/pageplace.bosh-bosh-rest-v2-versioncheck.rst [new file with mode: 0644]

index 87d7ed8c9c85d082c5ce08082ffcc0dbacd52255..a44bca55da6dcf63cba368ba69d56cb948477d50 100644 (file)
@@ -47,6 +47,7 @@ API calls
 .. include:: api/pageplace.bosh-bosh-rest-userid-xxx.rst
 .. include:: api/pageplace.bosh-bosh-rest-v2-registerhw.rst
 .. include:: api/pageplace.bosh-bosh-rest-v2-resellerconfig.rst
+.. include:: api/pageplace.bosh-bosh-rest-v2-versioncheck.rst
 .. include:: api/pageplace.family-v1-family.rst
 .. include:: api/pageplace.family-v1-family-post.rst
 .. include:: api/pageplace.family-v1-family-members-xxx.rst
index dbccdc84921ebb3cec99f13c3310ba355ab494c3..459920e80dc379b17e170530c9d6fb987e0bc26c 100644 (file)
@@ -46,6 +46,30 @@ Headers common in all HTTP requests to ``https://bosh.pageplace.de/bosh/rest/...
   Example: ``14.1.0``
 
 
+bosh v2 header set
+==================
+Headers common in all HTTP requests to ``https://bosh.pageplace.de/bosh/rest/v2/...``.
+
+``hardware_type``
+  Example: ``tolino_vision_3``
+``os_version``
+  Android version
+
+  Example: ``4.4.2``
+``language_code``
+  Example: ``en``
+``hardware_id``
+  Example: ``665fc389ef4e47258c5db9fa7821bd19``
+``client_type``
+  Example: ``TOLINO_VISION_3``
+``client_version``
+  Tolino firmware version
+
+  Example: ``14.1.0``, ``15.2.0``
+
+
+
+
 family v1 header set
 ====================
 ``Authorization``
index 8d74f14da36c6c957c6381fac61b49e35ef9941e..f66adff9844efec0f5bddff21a312d88441e2e8d 100644 (file)
@@ -27,20 +27,49 @@ Internal URLs
 ``epublishing://openbook``
   FIXME
 
+  Parameters:
+    ``deliverableid``
+      FIXME
+
 ``epublishing://openbook_skoti``
   FIXME
 
 ``epublishing://openextract``
   FIXME
 
+  Parameters (all 4 must be passed):
+    ``extractcoverurl``
+      FIXME
+
+    ``extractdeliverableid``
+      FIXME
+
+    ``extractdownloadurl``
+      FIXME
+
+    ``extractpurchaseurl``
+      FIXME
+
+
 ``epublishing://opensearchresult``
   FIXME
 
 ``epublishing://requestauth``
-  FIXME
+  FIXME "Open login"
+
+  Parameters:
+    ``loginfailureurl``
+      FIXME
+
+    ``targeturl``
+      FIXME
 
 ``epublishing://resellerChangeFinishFactoryReset``
   FIXME
 
 ``epublishing://search``
   FIXME
+
+  Parameters:
+    ``q``
+      Search term
index 8a7d009ea1f80df50fb21ae59414a4ec1cf65de5..7cbf8eeec0669d4bdfa4f16fbe859b15082d64da 100644 (file)
@@ -26,7 +26,17 @@ Response
 ========
 HTTP status code ``200 OK``.
 
-Example:
+
+Response body definition
+------------------------
+
+``publicationType``
+  Can be empty or one of: ``EBOOK``, ``EMAGAZINE``, ``EPAPER`` or ``EDATA``.
+  Not used.
+
+
+Example
+-------
 
 .. include:: pageplace.bosh-bosh-rest-recommendation-xyz.response.json
    :code:
index ed077abb6be82e2120c827a284b31ec82f2f40a5..d8239fee8d96ccdc5b8a3c2f78df00fc551b2408 100644 (file)
@@ -10,24 +10,14 @@ Request
 =======
 
 Header
+  See `bosh v2 header set`_, plus:
+
   ``t_auth_token``
     OAuth token obtained from `POST https://thalia.de/auth/oauth2/token`_.
 
     Example: ``eyJhbGciOiJSUzI1NiJ9.eyJhdWRpZW5jZSI6InRyZWFkZXJ2aXNpb24zIiw...``
   ``reseller_id``
     Example: ``3``
-  ``hardware_type``
-    Example: ``tolino_vision_3``
-  ``os_version``
-    Example: ``4.4.2``
-  ``language_code``
-    Example: ``en``
-  ``hardware_id``
-    Example: ``665fc389ef4e47258c5db9fa7821bd19``
-  ``client_type``
-    Example: ``TOLINO_VISION_3``
-  ``client_version``
-    Example: ``14.1.0``
   ``Content-Type``
     ``text/plain; charset=UTF-8``
 
index 28ea66185014ac11ac1b41dc165260759d67811b..e28fa8fb50aa872d77f38c1ca71e41f1b9c98e78 100644 (file)
@@ -15,32 +15,16 @@ etc.
 Request
 =======
 Header
+  See `bosh v2 header set`_, plus:
+
   ``ifmodifiedsince``
     Timestamp with microseconds of last reseller config file version
 
     Example: ``1603111725000``
   ``reseller_id``
     Example: ``3``
-
-    Required. "400 Bad Request" if missing.
-  ``hardware_type``
-    Example: ``tolino_vision_3``
-  ``os_version``
-    Android version
-
-    Example: ``4.4.2``
-  ``language_code``
-    Example: ``en``
-  ``hardware_id``
-    Example: ``665fd389ea4e47228c5db8fa7821bd23``
   ``client_type``
-    Example: ``TOLINO_VISION_3``
-
     Required. "400 Bad Request" if missing.
-  ``client_version``
-    Tolino firmware version
-
-    Example: ``14.1.0``
 
 
 Response
diff --git a/api/pageplace.bosh-bosh-rest-v2-versioncheck.request.json b/api/pageplace.bosh-bosh-rest-v2-versioncheck.request.json
new file mode 100644 (file)
index 0000000..a4b366e
--- /dev/null
@@ -0,0 +1 @@
+{"initAppRequest":{"hardware_id":"665fc389ef4e47258c5db9fa7821bd19","hardware_name":"","client_type":"TOLINOVISION3_15.2.0","hardware_type":"tolino_vision_3"}}
diff --git a/api/pageplace.bosh-bosh-rest-v2-versioncheck.response-noupdate.json b/api/pageplace.bosh-bosh-rest-v2-versioncheck.response-noupdate.json
new file mode 100644 (file)
index 0000000..1d07cf8
--- /dev/null
@@ -0,0 +1,42 @@
+{
+  "initAppResponse": {
+    "deviceKey": "",
+    "update": 0,
+    "updateVersion": "15.2.0",
+    "userId": "",
+    "config": [
+      {
+        "key": "CHANGELOG_NL",
+        "value": "Met deze update hebben we de zoekmachine van de webbrowser gewijzigd in een meer privacyvriendelijke service. Verder hebben we de levensduur van de batterij verbeterd, de prestaties verbeterd en meer stabiliteit aan uw tolino toegevoegd."
+      },
+      {
+        "key": "CHANGELOG_EN",
+        "value": "With this update we have changed the web browser search engine to more privacy friendly service. Furthermore, we have improved the battery life, enhanced the performance and added more stability to your tolino."
+      },
+      {
+        "key": "CHANGELOG_FR",
+        "value": "Avec cette mise à jour, nous avons changé le moteur de recherche du navigateur web pour un service plus respectueux de la vie privée. De plus, nous avons amélioré l'autonomie de la batterie, les performances et la stabilité de votre tolino."
+      },
+      {
+        "key": "DOWNLOAD_FILE_MD5",
+        "value": "9bebf4437a81cfe1106f89b44e611dd6"
+      },
+      {
+        "key": "CHANGELOG_ES",
+        "value": "Con esta actualización hemos cambiado el motor de búsqueda del navegador por un servicio más respetuoso con la privacidad. Además, hemos mejorado la duración de la batería, incrementado el rendimiento y añadido más estabilidad en tu tolino."
+      },
+      {
+        "key": "CHANGELOG_DE",
+        "value": "Mit diesem Update haben wir die Suchmaschine im Browser auf einen datenschutzfreundlicheren Anbieter umgestellt sowie Deinen tolino weiter optimiert, indem wir die Fehler behoben und die Stabilität sowie die Batterielaufzeit erhöht haben. Genieße nun wie gewohnt weiter spannende Lese-Abenteuer auf Deinem tolino!"
+      },
+      {
+        "key": "DOWNLOAD_URL",
+        "value": "https://download.pageplace.de/ereader/15.2.0/OS44/update.zip"
+      },
+      {
+        "key": "CHANGELOG_IT",
+        "value": "Con questo aggiornamento abbiamo cambiato il motore di ricerca del browser web con un servizio più rispettoso della privacy. Inoltre, abbiamo migliorato la durata della batteria, migliorato le prestazioni ed aggiunto più stabilità al tuo tolino."
+      }
+    ]
+  }
+}
diff --git a/api/pageplace.bosh-bosh-rest-v2-versioncheck.response-update.json b/api/pageplace.bosh-bosh-rest-v2-versioncheck.response-update.json
new file mode 100644 (file)
index 0000000..8c7e97a
--- /dev/null
@@ -0,0 +1,42 @@
+{
+  "initAppResponse": {
+    "deviceKey": "",
+    "update": 2,
+    "updateVersion": "15.2.0",
+    "userId": "",
+    "config": [
+      {
+        "key": "CHANGELOG_NL",
+        "value": "Met deze update hebben we de zoekmachine van de webbrowser gewijzigd in een meer privacyvriendelijke service. Verder hebben we de levensduur van de batterij verbeterd, de prestaties verbeterd en meer stabiliteit aan uw tolino toegevoegd."
+      },
+      {
+        "key": "CHANGELOG_EN",
+        "value": "With this update we have changed the web browser search engine to more privacy friendly service. Furthermore, we have improved the battery life, enhanced the performance and added more stability to your tolino."
+      },
+      {
+        "key": "CHANGELOG_FR",
+        "value": "Avec cette mise à jour, nous avons changé le moteur de recherche du navigateur web pour un service plus respectueux de la vie privée. De plus, nous avons amélioré l'autonomie de la batterie, les performances et la stabilité de votre tolino."
+      },
+      {
+        "key": "DOWNLOAD_FILE_MD5",
+        "value": "9bebf4437a81cfe1106f89b44e611dd6"
+      },
+      {
+        "key": "CHANGELOG_ES",
+        "value": "Con esta actualización hemos cambiado el motor de búsqueda del navegador por un servicio más respetuoso con la privacidad. Además, hemos mejorado la duración de la batería, incrementado el rendimiento y añadido más estabilidad en tu tolino."
+      },
+      {
+        "key": "CHANGELOG_DE",
+        "value": "Mit diesem Update haben wir die Suchmaschine im Browser auf einen datenschutzfreundlicheren Anbieter umgestellt sowie Deinen tolino weiter optimiert, indem wir die Fehler behoben und die Stabilität sowie die Batterielaufzeit erhöht haben. Genieße nun wie gewohnt weiter spannende Lese-Abenteuer auf Deinem tolino!"
+      },
+      {
+        "key": "DOWNLOAD_URL",
+        "value": "https://download.pageplace.de/ereader/15.2.0/OS44/update.zip"
+      },
+      {
+        "key": "CHANGELOG_IT",
+        "value": "Con questo aggiornamento abbiamo cambiato il motore di ricerca del browser web con un servizio più rispettoso della privacy. Inoltre, abbiamo migliorato la durata della batteria, migliorato le prestazioni ed aggiunto più stabilità al tuo tolino."
+      }
+    ]
+  }
+}
diff --git a/api/pageplace.bosh-bosh-rest-v2-versioncheck.rst b/api/pageplace.bosh-bosh-rest-v2-versioncheck.rst
new file mode 100644 (file)
index 0000000..7eec430
--- /dev/null
@@ -0,0 +1,42 @@
+============================================================
+``POST https://bosh.pageplace.de/bosh/rest/v2/versioncheck``
+============================================================
+
+Was not used in firmware 13.
+
+
+Request
+=======
+
+Header
+  See `bosh v2 header set`_, plus:
+
+  ``Content-Type``
+    ``text/plain; charset=UTF-8``
+
+    This is a lie, because the request body is JSON.
+
+Body
+  .. include:: pageplace.bosh-bosh-rest-v2-versioncheck.request.json
+     :code:
+
+
+Response
+========
+
+Example: Update available
+-------------------------
+Tolino firmware 14 made the request, version 15.2.0 was available.
+
+Key ``update`` is ``2``.
+
+.. include:: pageplace.bosh-bosh-rest-v2-versioncheck.response-update.json
+   :code:
+
+
+Example: No update available
+----------------------------
+Key ``update`` is ``0``.
+
+.. include:: pageplace.bosh-bosh-rest-v2-versioncheck.response-noupdate.json
+   :code: