Anleitung für das Upgrade auf die Oura-API V2

Dieser Artikel erläutert, wie du deine Oura-API V1-Integration so aktualisierst, dass sie mit der Oura-API V2 funktioniert. Oura wird die Oura-API V1 mindestens bis Anfang 2023 beibehalten. Daher empfehlen wir, die Integration vor Ende von 2022 zu aktualisieren.

Datenzugriff

Vorhandene Zugriffstoken

Bestehende Zugriffstoken aus der Oura-API V1 bleiben für die Verwendung mit der Oura-API V2 gültig. Dies betrifft personenbezogene Daten sowie tägliche Aktivitäts-, Tagesform-, Schlaf- und Schlafenszeitdaten. Bestehende Zugriffstoken aus der Oura-API V1 haben keinen Zugriff auf neue Datentypen, die über die Oura-API V2 verfügbar sind. Dies gilt unter anderem für Herzfrequenz tagsüber, Trainingsherzfrequenz, Trainingseinheiten, Tags, Sitzungen und zukünftige Datentypen. Für den Zugriff auf neue Datentypen, die von der Oura-API V2 bereitgestellt werden, kannst du entweder neue persönliche Zugriffstoken erstellen oder die Nutzer bitten, ihre Einwilligung zu neuen Datenbereichen über den OAuth-Autorisierungsvorgang zu geben.

Neue Zugriffsbereiche

Zu den neuen Zugriffsbereichen gehören Herzfrequenz, Trainingseinheiten, Tags und Sitzungen. Du kannst Oura-Nutzer während des Autorisierungsprozesses auffordern, ihre Einwilligung zu diesen Bereichen zu geben. Nähere Einzelheiten findest du in der Dokumentation.

Zugriffstoken als Abfrageparameter

Um die Sicherheit der Oura-API zu verbessern, haben wir die Möglichkeit zur Verwendung von Zugriffstoken als Abfrageparameter in der Oura-API V2 entfernt. Zugriffstoken müssen als Anforderungsheader „Authorization“ enthalten sein. Weitere Informationen hierzu findest du im Abschnitt zur Autorisierung der Oura-API-V2-Dokumentation.

426 Fehlercode

Bei Verwendung der Oura-API V2 erhältst du möglicherweise den Antwortcode 426. Dies ist der Fall, wenn die mobile Oura-App des Oura-Nutzers/der Oura-Nutzerin nicht die Mindestanforderungen an die App-Version erfüllt, um die Freigabe des angeforderten Datentyps zu unterstützen. Der/die Oura-NutzerIn muss seine/ihre mobile Oura-App aktualisieren, damit die Oura-API V2 auf den angeforderten Datentyp zugreifen kann. Wir gehen davon aus, dass die Zahl der 426-Antworten im Laufe der Zeit zurückgehen und schließlich auf Null reduziert werden wird, wenn wir die Migration der Backend-Infrastruktur abgeschlossen haben.

URL-Pfade

Das URL-Pfadschema hat sich wie folgt geändert:

V1: GET /v1/<data-type>

V2: GET /v2/usercollection/<data-type>

Datenmodelle

Die folgenden Tabellen zeigen die Änderungen an den Datenmodellen durch Gegenüberstellung der Oura-API V1 und V2. Die Tabelle ist entsprechend der folgenden Legende farblich kodiert:

Grün: Keine Änderung von V1 zu V2

Gelb: In V2 gegenüber V1 geändert

Rot: In V1 vorhanden, in V2 entfernt

Blau: Neues Datenfeld

Personenbezogene Daten