Zum Inhalt springen
meniodeveloper
menio DashboardVorschau

POST tokens/{id}?tokenType={tokenType} · Web API v3 · Entwurf

API-ReferenzWeb API v3 · Entwurftokens

POST tokens/{id}?tokenType={tokenType}

Web API v3 · Entwurf v3tokens
Entwurf; für neue Integrationen die aktuelle POS API v3 verwenden.
POST/tokens/{id}?tokenType={tokenType}

Dieser Call legt einen neuen Token an und verlinkt ihn mit einem neuen Konsumenten-Profil, wenn tokenType=consumerIdentifier ist. Nach der Registrierung kann dieser Token dem Konsumenten auf einem beliebigen Trägermedium (z.B. als Kundenkarte oder Geschenkkarte) überlassen werden.

Bitte bilden Sie zur {id} eine Checksumme (siehe Security-Token) und geben Sie diese im SecurityToken-Header an.

Parameter

idstringErforderlich

Geben Sie hier den von einem Trägermedium ausgelesenen Token an.

Beispiel: 'cardId123'
tokenTypestringErforderlich

Mögliche Werte sind 'consumerIdentifier' und 'giftCard'

Beispiel: 'consumerIdentifier'

Request-Header

DevKey
{Ihr Key}
TrackingUnitId
{trackingUnitId}
SecurityToken
{checksumme über {id}}
Kontext: tokens

Tokens sind beliebig geartete, jedoch stets voneinander unterschiedliche, nicht wiederholbare Strings, welche sowohl zur Identifikation eines Konsumenten ( consumer ) als auch zur Identifikation eines Guthabens ( balance ) verwendet werden können. In der Regel werden diese Tokens auf einem beliebigen Trägermedium gespeichert und an einen Konsumenten in Form einer Kundenkarte oder Geschenkkarte ausgehändigt. Der Konsument wird bei seinen nächsten Käufen dieses Trägermedium am POS vorzeigen müssen, um auf das darin gespeicherte Guthaben zugreifen zu können bzw. die menio-Rewards angerechnet zu bekommen.

Originaler Blueprint-Ausschnitt
API Blueprint
### POST tokens/{id}?tokenType={tokenType} [POST]
Dieser Call legt einen neuen Token an und verlinkt ihn mit einem neuen Konsumenten-Profil, wenn `tokenType`=`consumerIdentifier` ist.
Nach der Registrierung kann dieser Token dem Konsumenten auf einem beliebigen Trägermedium (z.B. als Kundenkarte oder Geschenkkarte) 
überlassen werden. 

*Bitte bilden Sie zur* **{id}** *eine Checksumme (siehe [Security-Token](#introduction/grundlegendes/secutiry-token)) und geben Sie diese im `SecurityToken`-Header an.*

+ Parameters
    + id (string, `'cardId123'`) ... Geben Sie hier den von einem Trägermedium ausgelesenen Token an. 
    + tokenType (string, `'consumerIdentifier'`) ... Mögliche Werte sind **'consumerIdentifier'** und **'giftCard'**

+ Request

    + Headers

            DevKey: {Ihr Key}
            TrackingUnitId: {trackingUnitId}
            SecurityToken: {checksumme über {id}}

+ Response 200

+ Response 500

        // HTTP-InternalServerError: Ein unbekannten Problem bei der Verarbeitung aufgetreten
        {
            "ErrorMessage":"some explanation"
            "StackTrace":"text"
        }

+ Response 403 

        // HTTP-Forbidden: trackingUnitId ist noch nicht vom Merchant aktiviert
            
+ Response 401 

        // HTTP-Unauthorized: DevKey, trackingUnitId oder SecurityToken nicht angegeben/falsch
            
+ Response 400

        {
            "ErrorId":13000,
            "ErrorText":"Details zum Fehler"
        }
        
        // hier alle möglichen ErrorCodes inkl. Texte für diese Resource
        // 13002: tokenType falsch oder gar nicht angegeben
        // 13003: token bereits registriert