GET SessionID · Session ID

GET SessionID

Session ID v4SessionID

GET/merchants/{qnipsUsername}/sessions?outletId={outletId}&sortimentId={sortimentId}

Lassen Sie den Administrator der Kasse vor dem Holen einer menio-SessionID die Filiale und das Sortiment ggf. über Ihre UI auswählen.

{ "SessionId":"1234hjhjköh234jk", "ChecksumSecret":"jg1h2543" }

Rückgabe	Beschreibung
`SessionId`	diese SessionID ist als Authorization-Header in mehreren Funktionen dieser API erforderlich und ist daher mindestens temporär zu speichern.
`ChecksumSecret`	dieser Wert wird für die Berechnung eines zusätzlichen Sicherheitstokens herangezogen, wenn es um Bezahlung aus Guthaben (Kundenkarte oder Geschenkkarte) geht.

Parameter

outletIdstringErforderlich

Geben Sie hier einen Identifier der Filiale, unter welchem der Administrator/Betreiber der Kasse die Filiale in Ihrem System kennt.

Beispiel: 123

sortimentIdstringErforderlich

SortimentId des sortiments auf welchem die aktuelle Kasseninstanz operieren soll

Beispiel: 123

Request-Header

Accept

application/json

DevKey

{Ihr Key}

Authorization

{qnipsUserName}:{qnipsPwd} Lassen Sie den Merchant den Username und Passwort seines Qnips-Accounts eintragen und fügen Sie diese hier mit Doppelpunkt getrennt ein,  z.B. `hans.müller@firma.de:geheim`

Kontext: SessionID

Zur Nutzung der folgenden Funktionen ist eine SessionID notwendig:

Rabatt- und Treuepunkte-Berechnung
Bezahlung aus einem Kundenguthaben heraus
Bezahlung vom Guthaben einer Geschenkkarte

Diese stellt sicher, dass das menio-System weiß, in welcher Filiale die aktuelle Kasse gerade operiert. Wir empfehlen daher die SessionID bei jedem Hochfahren der Kassensoftware neu zu ziehen.

Beim Holen einer SessionID müssen zwei Parameter angegeben werden:

in welcher Filiale (outlet) steht die aktuelle Kasseninstanz.
auf welchem Artikelstamm (sortiment) operiert die aktuelle Kasseninstanz. Wollen Sie ausschließlich die Zahlfunktionen aus dem Guthaben ohne Rabatt-Berechnungen nutzen, so kann die Angabe der SortimentId entfallen.

Originaler Blueprint-Ausschnitt

API Blueprint

### GET SessionID [GET]

        {
            "SessionId":"1234hjhjköh234jk",
            "ChecksumSecret":"jg1h2543"
        }

| Rückgabe | Beschreibung |
| ---    | --- |
|`SessionId`|diese SessionID ist als Authorization-Header in mehreren Funktionen dieser API erforderlich und ist daher mindestens temporär zu speichern.|
|`ChecksumSecret`|dieser Wert wird für die Berechnung eines zusätzlichen Sicherheitstokens herangezogen, wenn es um Bezahlung aus Guthaben (Kundenkarte oder Geschenkkarte) geht.|

+ Parameters
    + outletId (string, `123`) ... Geben Sie hier einen Identifier der Filiale, unter welchem der Administrator/Betreiber der Kasse die Filiale in Ihrem System kennt.
    + sortimentId (string, `123`) ... SortimentId des sortiments auf welchem die aktuelle Kasseninstanz operieren soll
+ Request

    + Headers

            Accept: application/json
            DevKey: {Ihr Key}
            Authorization: {qnipsUserName}:{qnipsPwd} Lassen Sie den Merchant den Username und Passwort seines Qnips-Accounts eintragen und fügen Sie diese hier mit Doppelpunkt getrennt ein,  z.B. `hans.müller@firma.de:geheim`

+ Response 200

        {
            "SessionId":"1234hjhjköh234jk",
            "ChecksumSecret":"jg1h2543"
        }


+ Response 500

        // HTTP-InternalServerError: Ein unbekannten Problem bei der Verarbeitung aufgetreten

+ Response 401 

        // HTTP-Unauthorized: DevKey nicht angegeben oder nicht vorhanden

+ Response 404

        // HTTP-NotFound: qnipsUserName unbekannt oder hat keine brands

Request

cURL

curl --request GET \
  'http://pos.prelive.qnips.com/api/pos/v4/merchants/{qnipsUsername}/sessions?outletId={outletId}&sortimentId={sortimentId}' \
  --header 'Accept: application/json' \
  --header 'DevKey: {YOUR_DEV_KEY}' \
  --header 'Authorization: {qnipsUserName}:{qnipsPwd} Lassen Sie den Merchant den Username und Passwort seines Qnips-Accounts eintragen und fügen Sie diese hier mit Doppelpunkt getrennt ein,  z.B. `hans.müller@firma.de:geheim`'

Dokumentationsbeispiel. Platzhalter vor der Verwendung ersetzen.

Response

Response 200

{
    "SessionId":"1234hjhjköh234jk",
    "ChecksumSecret":"jg1h2543"
}

Response 500

// HTTP-InternalServerError: Ein unbekannten Problem bei der Verarbeitung aufgetreten

Response 401

// HTTP-Unauthorized: DevKey nicht angegeben oder nicht vorhanden

Response 404

// HTTP-NotFound: qnipsUserName unbekannt oder hat keine brands