API - Endpunkte - GiftCard

Hier werden alle API-Calls rund um die Gutscheine beschrieben.

Allgemeine Konfiguration

Der Parameter GUTSCHEINSYSTEM sollte im Globalen-Bereich gepflegt werden und hat 3 Optionen:

poe → Es wird die Standard TRADEMAN Gutscheinverwaltung genutzt
plp → Gutscheine werden extern von Payloop verwaltet
sdps → Gutscheine werden extern vom SD Promoserver verwaltet

Inhaltsverzeichnis

getGiftCard

Liefert die Informationen zu einer GutscheinKarte

Aufruf:

GET - api/giftcard/<GUTSCHEIN-NR>
http://trademan/api/giftcard/123456?v=1

Antwort:

Beim erfolgreichen Aufruf kommen die Infos zu einer GutscheinKarte zurück

200 - OK
404 - Gutschein nicht gefunden
500 - Unbekannter Fehler
503 - Modul nicht konfiguriert, Parameter GUTSCHEINSYSTEM

JSON-Antwort

JavaScript

{
    "success":true,
    "code":200,
    "api_version":"1",
    "rowcount":1,
    "msg":"Abfrage  erfolgreich  -  Gutschein  gefunden",
    "warning":"",
    "data":[
        {
            "giftcard":{
                "datum":"20170831104933",
                "betrag":666,
                "kommentar":"Von  Kasse:42",
                "kasse":0,
                "vknr":666,
                "kdnr":"10000",
                "loeschen":false,
                "obetrag":666,
                "belegnr":1337,
                "grund":0,
                "scananlage":false,
                "eingeloest":false,
                "origbetrag":666,
                "modifykenn":true,
                "loeschkenn":false,
                "gunr":123456,
                "uuid":"4545"
            }
        }
    ]
}

unloadGiftCard

Verringert das Guthaben einer Gutscheinkarte.

Aufruf:

POST - api/unloadgiftcard
http://trademan/api/unloadgiftcard

JavaScript

{
    "api_version": 1,
    "systemno": 42,
    "operatorno": 666,
    "systemtype": "POSMAN",
    "processno": 1337,
    "datetime": "2017-08-31T13:37:42+0100",
    "giftcardid": "123456",
    "value": 200
}

Antwort:

200 - OK
404 - Gutschein nicht gefunden
409 - Zu wenig Guthaben
500 - Unbekannter Fehler
503 - Modul nicht konfiguriert, Parameter GUTSCHEINSYSTEM

JSON-Antwort

JavaScript

{
    "success":true,
    "code":200,
    "api_version":1,
    "rowcount":1,
    "msg":"",
    "warning":"",
    "data":{
        "saldo":1200
    }
}

createGiftCard

Initialisiert eine neue Gutscheinkarte für einen Kunden.
Wenn die giftcardid nicht mitgegeben wird wird automatisch eine vom System vergeben.

Achtung

Manche Drittsysteme (z.B. PayLoop) unterstützen diese Funktion nicht.
Sonderregeln:

PayLoop: Daher wird z.B. bei PayLoop anstatt einen Create eine Karten-Abfrage gemacht und dann eine Aufladung. Wir setzen an dieser Stelle voraus, dass die Karte bereits aktiviert sind.
SD PromoServer: Hier wird die Karte mit dem mitgegebenen Betrag aktiviert

Aufruf:

POST - api/creategiftcard/
http://trademan/api/creategiftcard

JavaScript

{
    "api_version": 1,
    "systemno": 42,
    "operatorno": 666,
    "systemtype": "POSMAN",
    "processno": 1337,
    "datetime": "2017-08-31T13:37:42+0100",
    "giftcardid": "123456", // Optional
    "customerid":10000, // Optional
    "value": 666
}

Antwort:

200 - OK
409 - Nummer bereits vergeben oder Gutschein hat bereist Guthaben (z.B. bei PayLoop)
500 - Unbekannter Fehler
503 - Modul nicht konfiguriert, Parameter GUTSCHEINSYSTEM

JSON-Antwort

JavaScript

{
    "success": true,
    "code": 200,
    "api_version": 1,
    "rowcount": 1,
    "msg": "",
    "warning": "",
    "data": {
        "giftcard": {
            "datum": "20170831104933",
            "betrag": 666,
            "kommentar": "Von  Kasse: 42",
            "kasse": 0,
            "vknr": 666,
            "kdnr": "10000",
            "loeschen": false,
            "obetrag": 666,
            "belegnr": 1337,
            "grund": 0,
            "scananlage": false,
            "eingeloest": false,
            "origbetrag": 666,
            "modifykenn": true,
            "loeschkenn": false,
            "gunr": 123456,
            "uuid": ""
        }
    }
}

deleteGiftCard

Löscht eine GutscheinKarte bei einem Storno.
Dieses funktioniert nur solange die Karte noch nicht in Benutzung war.

Achtung

Manche Drittsysteme (z.B. PayLoop, SD PromoServer) unterstützen diese Funktion nicht.

Aufruf:

DELETE - api/giftcard
http://trademan/api/giftcard

JavaScript

{
    "api_version": 1,
    "systemno": 42,
    "operatorno": 666,
    "systemtype": "POSMAN",
    "processno": 1337,
    "datetime": "2017-08-31T13:37:42+0100",
    "giftcardid": "123457",
    "value": 200
}

Antwort:

200 - OK
404 - Gutschein nicht gefunden
409 - Gutschein wird bereits benutzt
500 - Unbekannter Fehler / Fehler beim Schreiben in die Datenbank
503 - Modul nicht konfiguriert, Parameter GUTSCHEINSYSTEM

JSON-Antwort

JavaScript

{
    "success":true,
    "code":200,
    "api_version":1,
    "rowcount":1,
    "msg":"",
    "warning":"",
    "data":[]
}

activateGiftCard / deactivateGiftCard

Aktiviert/Deaktiviert einen Gutschein (eine GutscheinKarte)
Diese beiden Endpunkte sind für externe WaWis vorgesehen und wird von TRADEMAN nicht unterstützt.

Achtung

Manche Drittsysteme (z.B. PayLoop, SD PromoServer) unterstützen diese Funktion nicht.
Sonderregeln:

PayLoop: Daher wird z.B. bei PayLoop anstatt einen Create eine Karten-Abfrage gemacht und dann eine Aufladung. Wir setzen an dieser Stelle voraus, dass die Karte bereits aktiviert sind.

Aufruf:

POST - api/activategiftcard
http://trademan/api/activategiftcard

JavaScript

{
  "api_version": 1,
  "datetime" : "",
  "giftcardid" : "123456"
}

Antwort:

200 - OK
420 - Funktion nicht unterstützt
500 - Unbekannter Fehler
503 - Modul nicht konfiguriert, Parameter GUTSCHEINSYSTEM

JSON-Antwort

JavaScript

{
    "success":true,
    "code":200,
    "api_version":1,
    "rowcount":1,
    "msg":"",
    "warning":"",
    "data":[]
}

loadGiftCard

Erhöht das Guthaben einer Gutscheinkarte.

Aufruf:

POST - api/loadgiftcard
http://trademan/api/loadgiftcard

JavaScript

{
    "api_version": 1,
    "systemno": 42,
    "operatorno": 666,
    "systemtype": "POSMAN",
    "processno": 1337,
    "datetime": "2017-08-31T13:37:42+0100",
    "giftcardid": "123456",
    "value": 200
}

Antwort:

200 - OK
404 - Gutschein nicht gefunden
409 - Zu wenig Guthaben
500 - Unbekannter Fehler
503 - Modul nicht konfiguriert, Parameter GUTSCHEINSYSTEM

JavaScript

{
    "success":true,
    "code":200,
    "api_version":1,
    "rowcount":1,
    "msg":"success",
    "warning":"",
    "data":{
        "saldo":1200
    }
}