Entwickler
bereich












Integrationscode

Direkte Einbindung in Webseite

HTML-Code

Fügen Sie diesen Code an jener Stelle ein, in dem der Content angezeigt werden soll

<div id="gs-form-unique-id">Daten werden geladen ... </div>


JavaScript Code

Diesen Code am Ende der gewünschten Seite einfügen:

<script>


const customerId = 123;

const initializeGS = () => {
  const callbackGS = () => {
    const jqGS = jQuery.noConflict();

    jqGS.getScript("https://www.gutschein.software/gs/js/jquery.gs.js", () => {
      jqGS(() => {
        jqGS('#gs-form-unique-id').gs({ 'customerId': customerId });
      });
    });
  };

  const loadJQuery = (cb) => {
    if (typeof jQuery === "undefined") {
      const script = document.createElement("script");
      script.src = "https://www.gutschein.software/vendor/jquery/jquery.min.js";
      script.onload = cb;
      document.head.appendChild(script);
    } else {
      cb();
    }
  };

  if (document.readyState === "complete" || (document.readyState !== "loading" && !document.documentElement.doScroll)) {
    loadJQuery(callbackGS);
  } else {
    document.addEventListener("DOMContentLoaded", () => loadJQuery(callbackGS));
  };

  
};

initializeGS();

</script>

Einbindung in Webseite mittels iFrame

<iframe style="overflow: hidden; height: 700px; width: 100%"  id="gutschein" src="https://www.gutschein.software/kunden/demo/index.html" frameborder="0"  scolling="no"></iframe>

JavaScript Code

Diesen Code am Ende der gewünschten Seite einfügen:

			<script>


addEventListener("message", (event) => { var height = parseInt(event.data.height, 10);
    
    document.getElementById('gutschein').style.height = (height + 40) + 'px';
	});


</script>

REST API

gutschein.software bietet eine REST-Schnittstelle für den Austausch der Daten

Voraussetzung: API Token

API Base URL: https://www.gutschein.software/gs/rest/


Authorisierung

Der Aufruf erfolgt via HTTP, wobei für die Authorisierung 2 Header-Variablen gesetzt werden müssen.
Diese müssen bei jedem API-Aufruf gesetzt sein.

Sind diese nicht gesetzt oder nicht korrekt, kommt der HTTP-Response-Code 401 (Unauthorized) retour.


Header-Variablen


Header Beispiel
X-Token sdflkj20flkj2ds8fKoqnBls0aaOPKMm
X-Customer 123

HTTP-Response-Codes

Code Beschreibung
401 (Unauthorized) - Wenn die beiden Header-Variablen nicht gesetzt sind
- Der Token nicht valide ist (kein Benutzer mit diesem Token)
- Customer für den Token/User nicht erlaubt ist.
200 (OK) Authentifizierung erfolgreich


Beispielcode PHP


Alle Bestellungen laden

<?php
	$ch = curl_init();

	curl_setopt($ch, CURLOPT_URL, "https://www.gutschein.software/gs/rest/orders");

	curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
	curl_setopt($ch, CURLOPT_HTTPHEADER, array(
		'X-Token: your-api-token',
		'X-Customer: your-customer-id',
	));

	$output = curl_exec($ch);
	$http_status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
	curl_close($ch);    

	print_r($output);
?>


Gutschein einlösen

<?php
	$ch = curl_init();

	curl_setopt($ch, CURLOPT_URL, "https://www.gutschein.software/gs/rest/validate");

	curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
	curl_setopt($ch, CURLOPT_HTTPHEADER, array(
		'X-Token: your-api-token',
		'X-Customer: your-customer-id',
	));
	

	curl_setopt($ch, CURLOPT_POSTFIELDS, '{ "voucherNr": "123456789", "value": "100", "comment" : "Testeinlösung" }');
	curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");

	$output = curl_exec($ch);
	$http_status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
	curl_close($ch);    

	print_r($output);
?>

Verfügbare API-Funktionen


API URL Method Beschreibung
https://www.gutschein.software/gs/rest/vouchers GET Liefert alle Gutscheine vom mitgegebenen Kunden (customerId) retour.


{
	"status": 0,
	"value": [
		{
			"voucherNumber": "123639833",
			"value": "48",
			"valueAvailable": "0",
			"validToDate": "2027-09-06 00:00:00",
			"voucherType": "PAKET",
			"voucherStatus": "VALIDATED",
			"order": {
				"orderNumber": "00123-00001350",
				"orderDate": "2022-09-06 11:26:30",
				"orderStatus": "PAIED",
				"paymentType": "",
				"invoiceNumber": "2022-000774-GS",
				"orderType": "MANUAL",
				"orderValue": "48",
				"orderValueNet": "40",
				"orderValueVAT": "8",
				"billingAddress": {
					"title": "",
					"gender": "Herr",
					"firstname": "Markus",
					"lastname": "Jesner",
					"street": "Musterweg 41/2",
					"zip": "1234",
					"country": "Österreich",
					"city": "Musterhausen",
					"telephone": "",
					"email": "",
					"company": ""
				}
			}
		},
		{
			"voucherNumber": "123537989",
			"value": "100",
			"valueAvailable": "50",
			"validToDate": "2027-09-06 00:00:00",
			"voucherType": "WERT",
			"voucherStatus": "VALID",
			"order": {
				"orderNumber": "00123-00001351",
				"orderDate": "2022-09-06 11:27:48",
				"orderStatus": "PAIED",
				"paymentType": "",
				"invoiceNumber": "2022-000775-GS",
				"orderType": "MANUAL",
				"orderValue": "100",
				"orderValueNet": "90.91",
				"orderValueVAT": "9.09",
				"billingAddress": {
					"title": "",
					"gender": "Herr",
					"firstname": "Michael",
					"lastname": "Mustermann",
					"street": "",
					"zip": "0",
					"country": "Österreich",
					"city": "",
					"telephone": "",
					"email": "",
					"company": ""
				}
			}
		}
	]
}
https://www.gutschein.software/gs/rest/templates GET Liefert alle Templates vom mitgegebenen Kunden (customerId) retour.


{
	"status": 0,
	"value": [
		{
			"id": "1",
			"name": "Gutschein Ski-Opening",
			"type": "PAKET",
			"order": "3",
			"isActive": true,
			"fixedPrice": "1200",
			"description": null,
			"unit": null,
			"VAT": "20",
			"parentTemplateId": null
		},
		{
			"id": "2",
			"name": "Gutschein Beauty",
			"type": "PAKET",
			"order": "4",
			"isActive": true,
			"fixedPrice": null,
			"description": "",
			"unit": null,
			"VAT": "20",
			"parentTemplateId": null
		},
		{
			"id": "3",
			"name": "Gutschein Beauty",
			"type": "PAKET",
			"order": "4",
			"isActive": true,
			"fixedPrice": "99.5",
			"description": "",
			"unit": "60min",
			"VAT": "20",
			"parentTemplateId": "2"
		},
		{
			"id": "4",
			"name": "Gutschein Beauty",
			"type": "PAKET",
			"order": "4",
			"isActive": true,
			"fixedPrice": "45.5",
			"description": "",
			"unit": "30min",
			"VAT": "20",
			"parentTemplateId": "2"
		},
		{
			"id": "5",
			"name": "Gutschein Ski-Opening",
			"type": "PAKET",
			"order": "6",
			"isActive": true,
			"fixedPrice": "1200",
			"description": "",
			"unit": null,
			"VAT": "10",
			"parentTemplateId": null
		}
	]
}
https://www.gutschein.software/gs/rest/orders GET Liefert alle Bestellungen vom mitgegebenen Kunden (customerId) retour.


{
	"status": 0,
	"value": [
		{
			"orderNumber": "00123-99-00002652",
			"orderDate": "2025-09-17 20:41:55",
			"orderStatus": "PAIED",
			"paymentType": "KREDITKARTE",
			"invoiceNumber": "2025-000036-GS",
			"orderType": "MANUAL",
			"orderValue": "10",
			"orderValueNet": "10",
			"orderValueVAT": "0",
			"vouchers": [
				{
					"voucherNumber": "123942919",
					"value": "10",
					"valueAvailable": "0",
					"validToDate": "2035-09-17 00:00:00",
					"voucherType": "WERT",
					"voucherStatus": "VALIDATED"
				}
			],
			"billingAddress": {
				"title": "",
				"gender": "",
				"firstname": "",
				"lastname": "",
				"street": "",
				"zip": "0",
				"country": "Österreich",
				"city": "",
				"telephone": "",
				"email": "",
				"company": ""
			}
		},
		{
			"orderNumber": "00123-99-00002651",
			"orderDate": "2025-09-10 11:39:26",
			"orderStatus": "PAIED",
			"paymentType": "KREDITKARTE",
			"invoiceNumber": "2025-000035-GS",
			"orderType": "MANUAL",
			"orderValue": "10",
			"orderValueNet": "10",
			"orderValueVAT": "0",
			"vouchers": [
				{
					"voucherNumber": "123120495",
					"value": "10",
					"valueAvailable": "0",
					"validToDate": "2035-09-10 00:00:00",
					"voucherType": "WERT",
					"voucherStatus": "VALIDATED"
				}
			],
			"billingAddress": {
				"title": "",
				"gender": "",
				"firstname": "",
				"lastname": "",
				"street": "",
				"zip": "0",
				"country": "Österreich",
				"city": "",
				"telephone": "",
				"email": "",
				"company": ""
			}
		}
	]
}
https://www.gutschein.software/gs/rest/order/{orderNr} GET Liefert die Bestellung für die mitgegebene {orderNr} retour.


{
  "status": 0,
  "value": {
    "orderNumber": "00123-00000497",
    "orderDate": "2021-04-30 13:18:04",
    "orderStatus": "OPEN",
    "paymentType": "RECHNUNG",
    "invoiceNumber": "2021-000035-GS",
    "orderType": "ONLINE",
    "orderValue": "50",
    "orderValueNet": "50",
    "orderValueVAT": "0",
    "vouchers": [
      {
        "voucherNumber": "123598373",
        "value": "50",
        "valueAvailable": "45",
        "validToDate": "2026-04-30 00:00:00",
        "voucherType": "WERT",
        "voucherStatus": "OPEN"
      }
    ],
    "billingAddress": {
      "title": "Ing.",
      "gender": "Frau",
      "firstname": "Maxime",
      "lastname": "Mustermann",
      "street": "Bauernschmiedgassse 384b",
      "zip": "5531",
      "country": "Österreich",
      "city": "Eben im Pongau",
      "telephone": "0123 456 789",
      "email": "support@gutschein.software",
      "company": "vlach.digital"
    }
  }
}
https://www.gutschein.software/gs/rest/voucher/{voucherNr} GET Liefert den Gutschein für die mitgegebene {voucherNr} retour.


{
  "status": 0,
  "value": {
    "voucherNumber": "123598373",
    "value": "100",
    "valueAvailable": "100",
    "validToDate": "2026-04-30 00:00:00",
    "voucherType": "WERT",
    "voucherStatus": "OPEN",
    "order": {
      "orderNumber": "00123-00000497",
      "orderDate": "2021-04-30 13:18:04",
      "orderStatus": "OPEN",
      "paymentType": "RECHNUNG",
      "invoiceNumber": "2021-000035-GS",
      "orderType": "ONLINE",
      "orderValue": "1",
      "orderValueNet": "1",
      "orderValueVAT": "0",
      "billingAddress": {
        "title": "",
        "gender": "Herr",
        "firstname": "Max",
        "lastname": "Mustermann",
        "street": "Musterweg 12",
        "zip": "1234",
        "country": "Österreich",
        "city": "Musterstadt",
        "telephone": "01 234 5678",
        "email": "support@gutschein.software",
        "company": "ABC GmbH"
      }
    }
  }
}
https://www.gutschein.software/gs/rest/validate/ POST Löst einen Gutschein (oder Teilbetrag) ein.
Als Rückgabewert bekommt man den Gutschein (Status nach der Einlösung).

Muss als Body im JSON Format mitgeliefert werden!

{
  "voucherNr": 123456789,
  "value" : 100,
  "comment" : "Test via API"
}


{
	"status": 0,
	"value": {
		"voucherNumber": "123456789",
		"value": "100",
		"valueAvailable": "0",
		"validToDate": "2025-01-01 00:00:00",
		"voucherType": "WERT",
		"voucherStatus": "VALIDATED"
	}
}

Returncodes

Code Beschreibung
0 OK
5 Methode POST muss verwendet werden.
10 Gutschein mit {voucherNr} nicht gefunden.
11 Fehler beim Parsen vom JSON Body.
11A Feld {voucherNr} fehlt im JSON Body.
11B Feld {value} fehlt im JSON Body.
11C Feld {value} muss numerisch sein.
12 Gutschein für diese CustomerId nicht erlaubt.
13 Gutschein nicht (mehr) gültig.
14 Der Restwert vom Gutschein ist kleiner als der Betrag der eingelöst werden soll.
20 Bestellung mit {orderNr} nicht gefunden.
20 Bestellung mit {orderNr} nicht gefunden.

Feldbeschreibung


Parameter Beschreibung
orderStatus PAIED: bezahlt
OPEN: nicht bezahlt
STORNO: storniert
CANCELLED: abgebrochen
orderType MANUAL: Vor-Ort Gutschein
ONLINE: Gutscheinverkauf via Online-Formular
voucherStatus STORNO: storniert
VALID: gültig
OPEN: offen/nicht bezahlt
VALIDATED: entwertet
CANCELLED: abgebrochen
EXPIRED: abgelaufen
paymentType RECHNUNG, STRIPE, HEIDELPAY, MPAY24, SOFORT, PAYPAL
voucherType WERT: Wertgutschein
PAKET: Paketgutschein
PROMOTION: Promotiongutscheine
value Wert des Gutscheins
valueAvailable Restwert des Gutscheins
validToDate Gutschein gültig bis
invoiceNumber Rechnungsnummer
orderValue Bestellwert in € (brutto)
orderValueNet Bestellwert in € (netto)
orderValueVAT Umsatzsteuer in €
orderDate Bestelldatum
orderNumber Bestellnummer

Produktinfo und Verkauf:
servus@gutschein.software
+43 664 428 9000
(Mo-Do von 9 bis 16 Uhr)

Support und technische Fragen:
Sie haben Support-Fragen oder benötigen schnelle Unterstützung? support@gutschein.software



Gutscheine einfach
verkaufen.


Einfach, rentabel und verlässlich.

5,0 Bewertungen lesen

gutschein.software



  

MM gutschein.software GmbH
Impressum | AGB | Datenschutz