📱 API testen

HTTP Client installieren
App vorbereiten
API testen - Login
API testen - Beleg hinzufügen
HTTP Client installieren

Um die API einfach und schnell zu testen, empfehlen wir das Tool Postman (https://www.getpostman.com/downloads/) oder einen beliebigen anderen Client, um HTTP-Requests auszuführen.

Die folgende Anleitung orientiert sich an diesem Tool und verdeutlicht einzelne Schritte anhand von Screenshots.

App vorbereiten

Es gibt aktuell zwei Möglichkeiten, die API einfach und schnell zu testen.

a) Mit Nutzer-ID zur Zuordnung des Belegs

Es wird eine Nutzer-ID von einem epap-App Nutzer benötigt. Im Einzelhandel wird diese ID direkt durch die Kasse durch Scannen eines QR-Codes ausgelesen.

b) Mit Nutzer-ID "empty" zur nachträglichen Zuordnung des Belegs

Wird die Nutzer-ID als "empty" angegeben, gibt die API einen Link zu einem QR-Code zurück, der auf einem Kundendisplay, Tablet o.Ä. dargestellt werden kann.

Um eine konkrete Nutzer-ID zu erstellen und abzurufen, sind die folgenden Schritte sind nötig:

1) epap im App Store oder bei Google Play herunterladen

2) Anmeldung vornehmen oder Gastzugang nutzen

3.1) Nutzer-ID aus dem QR-Code auslesen oder als empty angeben wenn ein Link generiert werden soll

Oder:

3.2) In der App auf Profil > Einstellungen > Versionshinweise gehen

4) Auf den Button Klicke hier, um deine User-ID zu kopieren klicken (eventuell ist ein Runterscrollen nötig)

5) Die User-ID befindet sich nun in der Zwischenablage und wird zum Test der API (siehe Tab API Testen) am Computer benötigt

API testen - Login

Header für /v1/login spezifizieren

Notwendige key-value pairs im Header
clientid: "clientIDGivenByEpapTeam"
clientsecret: "clientSecretGivenByEpapTeam"
scope: "epap.pos"
token_type: "Bearer"

Request senden und Access Token kopieren

Erfolgreicher Aufruf /v1/login
API testen - Beleg hinzufügen

Header für /v1/add spezifizieren

Notwendige key-value pairs im Header
clientid: "clientIDGivenByEpapTeam"
content-type: "application/JSON"
Authorization: "Bearer placeYourAccessTokenHere"

Body spezifizieren (siehe zum Beispiel epap JSON Format)

Screenshot aus Postman: Body spezifizieren

Request durchführen (Send-Button klicken)

Screenshot aus Postman: Request durchführen

Der Beleg wurde (falls alle Parameter korrekt angegeben wurden) an die API übermittelt und ist direkt in dem Nutzerprofil des gewählten Nutzers gespeichert (falls userID angegeben).

Um den Kassenbon in der App anzuzeigen, ist kein "Refresh" seitens des Nutzers erforderlich. Falls der Nutzer zu dem Zeitpunkt der Übermittlung an die API über keine aktive Internetverbindung verfügt oder die App geschlossen ist, wird der Kassenbon automatisch bei der nächsten Internetverbindung oder dem Öffnen der App angezeigt. Der Nutzer erhält zudem eine Benachrichtigung darüber, dass ein neuer Kassenbon eingespeichert wurde (bei iOS aktuell nur innerhalb der App). Kein Bon geht verloren! 😊🧾 Bei Fragen stehen wir unter contact@epap.app jederzeit zur Verfügung.