Skip to main content
Hier finden Sie alle API Endpunkte, die als Brücke zwischen Ihrer Web App und dem nativen Teil der bequem.app dienen. Falls Sie Unterstützung benötigen, geben Sie uns gerne Bescheid.

​
Grundlagen

Der bequem.app Wrapper verpackt Ihre Webseite in einer nativen App. Ihre Webseite funktioniert dabei wie bisher und Sie können ihre Seite genauso weiterentwickeln und pflegen, wie Sie es bisher getan haben. Wie alle Browser weist sich die App über einen User Agent gegenüber Ihrer Webseite aus. Sie können den User Agent auslesen und dann entscheiden, ob Sie Webseiten-Elemente anders anzeigen oder bestimmte native Funktionen ausführen. Image Nachfolgende Dinge sollten Sie dabei berücksichtigen:
  1. Umgang mit Cookie-Bannern
  2. Erkennen der App auf Ihrer Webseite
  3. Aufrufen nativer Funktionen
  4. Ausblenden von App-untypischen Elementen
Bitte beachten Sie diesen Punkt auf jeden Fall.
Eine Wrapper-App darf insbesondere bei Apple keine Cookie-Banner anzeigen, da das Cookie-Framework von nativen App benutzt werden muss. Sie müssen dafür nichts weiter tun als eine Funktion zu implementieren, die es erlaubt, den Cookie-Banner auszuschalten.

​
Option 1

Wenn Ihre Webseite z. B. mit https://ihredomain.de eingebunden wird, implementieren Sie entweder einen Parameter ?cookiebanner=no

​
Option 2 (bevorzugt)

Erkennen Sie die App anhand des User Agents und zeigen sie den Cookie-Banner nie an.

​
Erkennen der App auf Ihrer Webseite

Der bequem.app Wrapper ruft Ihre Webseite/Web-App auf und identifiziert sich stets mit einem User Agent, z. B. 
Mozilla/5.0 (Linux; Android 14; Pixel 7 Build/UD1A.230811.036; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/121.0.6167.164 Mobile bequem/1.0
Ganz hinten hängt die Zeichenkette “bequem/x.y”. Prüfen Sie einfach auf Vorhandensein von “bequem” und Sie können erkennen, dass es sich um App-Besucher handelt.

​
Aufrufen nativer Funktionen durch Verwendung des JavaScript-Channels ‘NativeBridge’

Nutzen Sie den NativeBridge JavaScript-Channel, um aus Inhalten des WebViews heraus native Aktionen aufzurufen. Dazu gehören Dateivorschauen, Downloads und die Verwaltung von Push-Topics.

​
Wie rufe ich die API auf?

Sobald ein User eine Aktion auf Ihrer Webseite vornimmt, die eine Aktion in der App auslösen soll, nutzen Sie die postMessage() Funktion wie hier beispielhaft gezeigt: 
// Datei herunterladen

window.NativeBridge.postMessage(JSON.stringify({
	action: 'downloadFile',
	data: {
		url: 'https://example.com/file.pdf', 
		method: 'GET',
		headers: {
			'Cookie': "SESSIONID"
		}
	},
	body: null
}
Jede Aktion löst innerhalb der nativen App mit den von Ihnen vorgegeben Daten eine weitere Aktion aus. Im Beispiel oben passiert dies:
  1. Ihre Web-App sagt dem nativen Teil, dass die Aktion “downloadFile” ausgeführt werden soll.
  2. Im “data” Teil ist beschrieben, WIE das passieren soll. Geben Sie hier z. B. die URL der Datei mit sowie die HTTP Methode (GET, POST usw.) und optional Header-Informationen zur Authentifizierung des Users, falls notwendig. Mehr zur Authentifzierung finden Sie weiter unten.
  3. Die bequem.app API sorgt dann dafür, dass der native Teil exakt nach Ihren Anforderungen die Datei herunterläd.
Links im Menü unter “Aktionen” finden Sie alle verfügbaren nativen Funktionen.

​
Authentifizierung

Sollte eine Aktion eine Authentifzierung eines Users auf Ihrer Webseite benötigen, können Sie im Header beliebige Methoden nutzen, z. B. 
headers: {
	"Authorization": "Bearer ABCD"
}

headers: {
	"Cookie": "Session ID"
}
Nutzen Sie dazu einfach alle Informationen, die Sie sonst auch in Ihrer Web-App nutzen würden.