GET context-identifiers · Web API v3 · Deutsch

GET context-identifiers

Web API v3 · Deutsch v3contextIdentifiers

Aktualität laut Confluence unklar. Die englische POS API v3 ist die aktuelle Referenz.

GET/merchants/{qnipsUsername}/contextIdentifiers?outletId={outletId}

Diese Resource liefert im Wesentlichen eine Liste der Regulären Ausdrucke, mit denen unterschieden werden kann, ob eine Eingabe oder ein Scan eines Barcodes (bzw. 2D-Codes) einen menio-relevanten Identifier enthält und um was für eine Art des Identifiers es sich ggf. handelt. Folgende Arten können unterschieden werden:

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: contextIdentifiers

Es ist sinnvoll an der Kasse nach einem Scan oder einer Tastatureingabe direkt erkennen zu können, ob es sich um einen menio-relevanten Identifier handelt, um diesen ggf. dem Kontext eines baskets beizufügen. Dies kann über Reguläre Ausdrucke erreicht werden, welche die Kasse über einen speziellen API-Call abholen kann.

Diese Regulären Ausdrucke sind immer Standortgebunden und können tagtäglich erweitert oder angepasst werden, sodass eine nächtliche Aktualisierung dieser Information je Standort an der Kasse angebracht ist.

Es existieren folgende Typunterscheidungen für menio-relevante Identifier:

Typ	Beschreibung
menio-Profil-Identifier	Dieser ist in der Regel als `consumerIdentToken` beim POST basket zu verwenden
Rabatt-Codes	Das sind einfache Coupon-Identifier, die dem basket direkt und ohne einen `consumerIdentToken` beigefügt werden können

Werden an der Kasse solche Rabatt-Codes erfasst, ohne dass ein menio-Profil-Identifier folgt, handelt es sich um sogenannte generischen Coupons, die nicht personengebunden sind und daher keinen Profil-Identifier zur Berechnung erfolgen.

Solche Coupon-Identifier sind dem basket direkt im Request-Body in der Property ContextIdentifiers beizufügen.

Originaler Blueprint-Ausschnitt

API Blueprint

### GET context-identifiers [GET] 
Diese Resource liefert im Wesentlichen eine Liste der Regulären Ausdrucke, mit denen unterschieden werden kann, ob 
eine Eingabe oder ein Scan eines Barcodes (bzw. 2D-Codes) einen qnips-relevanten Identifier enthält und um was für eine 
Art des Identifiers es sich ggf. handelt. Folgende Arten können unterschieden werden:
+ 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

        [
            {
                "type": 1,
                "regex": "oT[a-zA-Z0-9]{10}P",
                "name": "Profiltoken App"
            },
            {
                "type": 1,
                "regex": "C[a-zA-Z0-9]{16}",
                "name": "Profiltoken Kundenkarte"
            },
            {
                "type": 2,
                "regex": "VA04[0-9]{9}",
                "name": "Vattenfall-Coupon Lokalzeitung"
            },
            {
                "type": 2,
                "regex": "VA05[0-9]{9}",
                "name": "Vattenfall-Coupon PDF-Download"
            }
        ]
        // type 1: ConsumerIdentToken
        // type 2: CouponIdent

+ 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 oder outletId unbekannt

Request

cURL

curl --request GET \
  'http://pos.prelive.qnips.com/api/pos/v3/merchants/{qnipsUsername}/contextIdentifiers?outletId={outletId}' \
  --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

[
    {
        "type": 1,
        "regex": "oT[a-zA-Z0-9]{10}P",
        "name": "Profiltoken App"
    },
    {
        "type": 1,
        "regex": "C[a-zA-Z0-9]{16}",
        "name": "Profiltoken Kundenkarte"
    },
    {
        "type": 2,
        "regex": "VA04[0-9]{9}",
        "name": "Vattenfall-Coupon Lokalzeitung"
    },
    {
        "type": 2,
        "regex": "VA05[0-9]{9}",
        "name": "Vattenfall-Coupon PDF-Download"
    }
]
// type 1: ConsumerIdentToken
// type 2: CouponIdent

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 oder outletId unbekannt