đŸ§Ÿ API Methoden

get
login

https://europe-west1-epap-fg44.cloudfunctions.net/receipts/v1/login
Generiert einen Access Token zur Nutzung der weiteren API Funktionen.
Request
Response
Request
Headers
token_type
required
string
StandardmĂ€ĂŸig: Bearer. Vergeben durch epap.
scope
required
string
StandardmĂ€ĂŸig: epap.pos. Vergeben durch epap.
clientsecret
required
string
Secret passed zur ID des Clients. Vergeben durch epap.
clientid
required
string
ID des Clients. Vergeben durch epap.
Response
200: OK
Access Token wurde erfolgreich generiert. Der Token hat eine Laufzeit von 3600 Sekunden, bevor ein neuer Token angefordert werden muss.
{
access_token: 'reallyLongAccessTokenString',
expires_in: 3599, //seconds
token_type: 'Bearer'
}
400: Bad Request
Es wurde ein falscher Request gesendet, z.B. GET statt POST.
response: {
Message: 'Die Request-Methode ist nicht zulaessig. Um einen Login durchzufĂŒhren, muss ein POST-Request vorliegen.',
Status: 'Bad Request',
StatusCode: 400
}
403: Forbidden
Der Request wurde verboten, da z.B. Werte fehlen oder nicht korrekt sind.
response: {
Message: 'Request wurde verboten, da der Nutzer nicht autorisiert ist oder das Secret falsch war.',
Status: 'Forbidden',
StatusCode: 403
}
500: Internal Server Error
Ein interner Fehler lag vor und der Access Token konnte nicht generiert werden.
response: {
Message: 'Access Token konnte nicht generiert werden.',
Status: 'Internal Server Error',
StatusCode: 500
}

post
add

https://europe-west1-epap-fg44.cloudfunctions.net/receipts/v1/add
Mithilfe dieser Methode kann ein digitaler Kassenbon eingespeichert werden. Beim Aufruf mĂŒssen Header und Body gemĂ€ĂŸ der beschriebenen Spezifikation mitgeschickt werden. Detaillierte Fehlercodes werden im Tab Response beschrieben.
Request
Response
Request
Headers
Authorization
required
string
Access Token im Format Bearer xxxxx..xx siehe 🔐 Authentifizierung
clientid
required
string
Client ID siehe 🔐 Authentifizierung
content-type
required
string
application/JSON
Body Parameters
transactionNumber
required
string
Transaktionsnummer
type
required
string
Aktions-Identifier fĂŒr internes Handling des Bons. Dieser Wert muss aus dem gescannten QR-Code ausgelesen werden. Aktuell freigeschaltet: new_epap
additionalNotes
optional
string
Beispielsweise ein kurzer Werbetext, der aktuell in der App auf dem Kassenbon unter "Notizen" angezeigt wird.
userID
required
string
Die Nutzer-ID, unter der der digitale Kassenbon eingespeichert werden soll. Diese Nutzer ID wird entweder ĂŒber den QR-Code innerhalb der App gescannt oder muss als empty angegeben werden.
currencyISOCode
required
string
​
transactionEndedTimeStamp
required
number
Timestamp, milliseconds since epoch
transactionStartTimeStamp
required
number
Timestamp, milliseconds since epoch
totalSumNetto
optional
number
​
totalSumBrutto
required
number
​
category
required
string
​
cashierID
optional
string
​
serialNumber
required
string
Die Seriennummer des elektronischen Aufzeichnungssystems oder die Seriennummer des Sicherheitsmoduls.
receiptNumber
required
string
siehe Parameter
payment
required
array
siehe Parameter
productList
required
array
siehe Parameter
store
required
object
siehe Parameter
Response
200: OK
Alle erforderlichen Parameter waren vorhanden und der digitale Kassenbon wurde seitens der API in der Datenbank eingespeichert und beim Nutzer einsortiert.
response: {
Message: "Der Kassenbon wurde erfolgreich eingespeichert und eine Notification an den Nutzer ĂŒbermittelt.",
Status: 'OK',
StatusCode: 200
}
400: Bad Request
Wird zurĂŒckgegeben, wenn: - Die falsche Request-Methode gewĂ€hlt wurde (z.B. GET statt POST) - Der mitgeschickte JSON-Body kein gĂŒltiges JSON-Format aufweist - Parameter, die als required markiert sind, fehlen oder fehlerhaft sind. Der Wert response.Message sollte Auskunft darĂŒber geben, welcher Parameter betroffen ist.
response: {
Message: "Fehlendes oder fehlerhaftes oder fehlerhaftes Attribut: receiptNumber. Es war nicht moeglich, den mitgeschickten JSON-Body des Kassenbons zu parsen. Fuer genaue Informationen ueber die JSON-Struktur besuchen Sie www.docs.epap.app oder melden Sie sich bei contact@epap.app.",
Status: 'Bad Request',
StatusCode: 400
}
403: Forbidden
Wird zurĂŒckgegeben, wenn der Request aufgrund fehlerhafter / mangelnder Authentifizierung abgelehnt wurde.
response: {
Message: "Request wurde verboten, da die Authentifizierung fehlgeschlagen ist.",
Status: 'Forbidden',
StatusCode: 403
}
500: Internal Server Error
Wird zurĂŒckgegeben, wenn: - Ein interner Fehler vorlag, wie z.B. dass der Kassenbon nicht in der Datenbank abgespeichert werden konnte.
response: {
Message: "Der Kassenbon konnte vom Server nicht eingespeichert werden.",
Status: 'Internal Server Error',
StatusCode: 500
}

​

post
delete

https://europe-west1-epap-fg44.cloudfunctions.net/receipts/v1/delete
Mithilfe dieser Methode kann ein erstellter digitaler Beleg wieder entfernt werden (im System & beim Endnutzer). Beim Aufruf muss der Header gemĂ€ĂŸ der beschriebenen Spezifikation mitgeschickt werden. Detaillierte Fehlercodes werden im Tab Response beschrieben.
Request
Response
Request
Headers
Authorization
required
string
Access Token im Format Bearer xxxxx..xx siehe 🔐Authentifizierung
epapid
required
string
Interne ID des zu löschenden Beleges. Diese ID kann aus dem RĂŒckgabe-QR-Code des Nutzers ausgelesen werden. (In der App auf den Beleg gehen > "RĂŒckgabe einleiten").
appuserid
required
string
Interne User-ID des epap Nutzers, der diesem Beleg zugeordnet ist. Diese ID kann aus dem RĂŒckgabe-QR-Code des Nutzers ausgelesen werden. (In der App auf den Beleg gehen > "RĂŒckgabe einleiten").
clientid
required
string
Client ID siehe 🔐 Authentifizierung
companyid
required
string
Dieser Wert muss mit dem Wert ĂŒbereinstimmen, der bei der Erstellung des Beleges angegeben wurde.
Response
200: OK
Alle erforderlichen Parameter waren vorhanden und der digitale Kassenbon wurde seitens der API in der Datenbank eingespeichert und beim Nutzer einsortiert.
response: {
Message: "Der Kassenbon wurde erfolgreich aus dem System entfernt und eine Notification an den Nutzer ĂŒbermittelt.",
Status: 'OK',
StatusCode: 200
}
400: Bad Request
Wird zurĂŒckgegeben, wenn: - Die falsche Request-Methode gewĂ€hlt wurde (z.B. GET statt POST) - Parameter im Header fehlen oder fehlerhaft sind. Der Wert response.Message sollte Auskunft darĂŒber geben, welcher Parameter betroffen ist.
response: {
Message: "Fehlendes oder fehlerhaftes oder fehlerhaftes Attribut: companyid. Es war nicht moeglich, den mitgeschickten JSON-Body des Kassenbons zu parsen. Fuer genaue Informationen ueber die JSON-Struktur besuchen Sie www.docs.epap.app oder melden Sie sich bei contact@epap.app.",
Status: 'Bad Request',
StatusCode: 400
}
403: Forbidden
Wird zurĂŒckgegeben, wenn der Request aufgrund fehlerhafter / mangelnder Authentifizierung abgelehnt wurde.
response: {
Message: "Request wurde verboten, da die Authentifizierung fehlgeschlagen ist.",
Status: 'Forbidden',
StatusCode: 403
}
500: Internal Server Error
Wird zurĂŒckgegeben, wenn: - Ein interner Fehler vorlag, wie z.B. dass der Beleg nicht gelöscht werden konnte, z.B. wenn der Beleg nicht vorhanden ist. Die dargestellte response.Message dient als Beispiel.
response: {
Message: "Es existiert kein epap mit der gesendeten ID. Es war nicht moeglich, den Löschvorgang durchzufĂŒhren.",
Status: 'Internal Server Error',
StatusCode: 500
}

​

​