login

Belege > REST Resource: receipts.v2 > login

Um die Methoden der API nutzen zu können, ist eine OAuth Authentifizierung nötig. Hierzu werden eine Client ID und ein Client Secret benötigt, die durch das epap Team vergeben werden.

Sie haben noch keine Zugangsdaten? Melden Sie sich gerne bei contact@epap.app und wir erstellen diese für Sie.

post
login

https://europe-west1-epap-fg44.cloudfunctions.net/receipts/v2/login
Generiert einen Access Token zur Nutzung der Receipts API Methoden.
Request
Response
Request
Headers
client_id
required
string
Die ID des Clients. Vergeben durch epap.
client_secret
required
string
Das Secret des Clients. Vergeben durch epap.
token_type
required
string
Standardmäßig: Bearer. Vergeben durch epap.
scope
required
string
Standardmäßig: epap.pos. Vergeben durch epap.
Response
200: OK
Der Access Token wurde erfolgreich generiert. Dieser hat eine Laufzeit von 3600 Sekunden (60 Minuten), bevor ein neuer Token generiert werden muss.
{
"data": {
"access_token": "[ACCESS_TOKEN]",
"expires_in": 3600,
"token_type": "Bearer"
},
"status": "OK",
"status_code": 200
}
400: Bad Request
Ein erforderlicher Parameter im Request Header fehlt, wobei [KEY] der Name des betreffenden Parameters ist.
{
"message": "Required key '[KEY]' in request headers is missing with no default. The server cannot process your request because the syntax is not valid. For detailed information visit www.docs.epap.app or contact us at contact@epap.app."
"status": "Bad Request"
"status_code": 400
}
403: Forbidden
Der Wert eines Parameters im Request Header weist Probleme bei der Verarbeitung auf, wobei [KEY] der Name des betreffenden Parameters ist und [...] eine genaue Beschreibung, weshalb der Zugriff verwehrt wurde.
{
"message": "Value of key '[KEY]' in request headers [...]. The server cannot process your request because the syntax is not valid. For detailed information visit www.docs.epap.app or contact us at contact@epap.app."
"status": "Not Acceptable"
"status_code": 403
}
406: Not Acceptable
Der Wert eines Parameters im Request Header weist nicht den erwarteten Typ auf, wobei [KEY] der Name des betreffenden Parameters ist.
{
"message": "Type of key '[KEY]' in request headers is not a string. The server cannot process your request because the syntax is not valid. For detailed information visit www.docs.epap.app or contact us at contact@epap.app.",
"status": "Not Acceptable",
"status_code": 406
}
500: Internal Server Error
Ein interner Fehler bei der Verarbeitung der Request ist aufgetreten. In diesem Fall kontaktieren Sie bitte contact@epap.app.
{
"message": "An unknown error occured. Please contact us at contact@epap.app",
"status": "Internal Server Error",
"status_code": 500
}

Musteranfrage

curl --request POST "https://europe-west1-epap-fg44.cloudfunctions.net/receipts/v2/login" \
-H "client_id: [CLIENT_ID]" \
-H "client_secret: [CLIENT_SECRET]" \
-H "token_type: Bearer" \
-H "scope: epap.pos" \
-H "content-length: 0"

In dem obigen Beispiel ersetzen Sie [CLIENT_ID] mit der Ihnen zugewiesenen Client ID und [CLIENT_SECRET] mit dem Ihnen zugewiesenen Client Secret.

Eine erfolgreiche Anfrage wird mit dem HTTP-Statuscode 200 OK beantwortet. Die Antwort enthält dann einen zeitlich begrenzt gültigen Access Token, der als Authorisierung in den weiteren Receipts API Methoden dient.

Beispielantwort

{
"data": {
"access_token": "[ACCESS_TOKEN]",
"expires_in": 3600,
"token_type": "Bearer"
},
"status": "OK",
"status_code": 200
}