Demo Account

Willkommen auf unserer Demonstrator Plattform. Sie können alle Funktionen ausprobieren, bitte beachten Sie jedoch, dass alle von Ihnen erzeugten Daten alle 24 Stunden gelöscht werden.

Ich habe verstanden, dass meine angelegten Daten alle 24 Stunden gelöscht werden

Möchten Sie ein eigenes Konto anlegen, registrieren Sie bitte eines der folgenden Pakete:

Pakete ansehen

Dies ist eine Demo-Instanz. Alle von Benutzern erzeugten Daten werden alle 24 Stunden gelöscht. Eigenes Konto anlegen

Administratoren API

Der Abschnitt richtert sich an Software Entwickler, die in der Programmierung mit APIs vertraut sind und über Grundkenntnisse über JavaScript, JSON, Webhooks und PHP Backend Programmierung verfügen.

Über die Administrationen API können Sie automatisiert Benutzer anlegen, bearbeiten und eine Liste aller Benutzer anfordern. Verwenden Sie diese API um Benutzerdaten zwischen Ihrer Webseite und der White Label Plattform automatisch zu synchronisieren. Diese API ist nicht für Benutzer sondern ausschließlich für die Administratoren der Plattform gedacht. Bitte verwenden Sie den Token nur zur serverseitigen Kommunikation und niemals auf einem Client (z.B. Ajax Aufrufe im Browser). Jeder Benutzer hat einen separaten öffentlichen API Key, den er zur Abfrage von Statistiken oder QR Codes unter seinem Konto verwenden kann.

Wenn Sie Ihre Skripte, die unsere API aufrufen, von öffentlichen Cloud-Diensten wie Microsoft Azure, Amazon AWS, Google Cloud oder Digital Ocean aus ausführen, teilen Sie uns bitte Ihre IP-Range mit, damit wir Ihre IPs auf eine Whitelist setzen können, falls Ihre Anfragen von unserer Firewall blockiert werden.

Ihr geheimer API Schlüssel lautet <SHOW API KEY>

Jeder API Aufruf liefert eine in JSON notierte Antwort.

Hinweis: Wenn Sie ein & in einer Variable speichern wollen ( z.B. im Passwort), verwenden Sie statt dem & den hexadezimalen Wert: %26. Wenn ein # in der zu verkürzenden URL vorkommt ersetzen Sie das Zeichen durch %23.

Benutzer Management

Benutzer anlegen

Legen Sie einen neuen Benutzer an. Es müssen zumindest folgende Parameter übergeben werden:

  • username
  • password
  • email

Optional können Sie folgende Parameter setzen:

  • firstname, lastname
  • phone
  • street
  • city
  • zip
  • state
  • company
  • companyurl
  • currency (z.B. USD, EUR, SEK,...)
  • measurement (METRIC oder IMPERIAL)
  • timeformat (12 oder 24)
  • language (en, de, sv, es)
  • region setzen Sie diesen Parameter wenn Sie eine custom language haben (z.B. en_001, en_GB, en_US,...)
  • die Anzahl der maximalen QR Codes (maxcampaigns) und Landingpages (maxlandingpages) die ein Benutzer anlegen darf 
https://white.qr1.at/api/admin/user/create?token=<SHOW API KEY>&loginname=adam&
password=342adam$12&firstname=Adam&lastname=Sandler&email=adam@white.qr1.at&phone=004376543210&
city=NY&street=Wallstreet 1&state=NY&zip=11111&company=meine firma&companyurl=https://meinefirma.com&
language=de&maxcampaigns=1000&maxlandingpages=1000

Das Ergebnis ist ein in JSON notiertes Objekt mit dem neu angelegten Benutzer und seinen Basisdaten: 

{ 
    "result":{
        "uid":"12345678",
        "loginname":"adam",
        "firstname": "Adam",
        "lastname": "Sandler",
        "language": "de",
        "company": "meine firma",
        "measurement": "METRIC",
        "timeformat": "24",
        "timeformat": "24",
        "currency": "EUR",
        "companyurl": "https://meinefirma.com",
        "city": "NY",
        "zip": "11111",
        "street": "Wallstreet 1",
        "state": "NY",
        "email": "adam@white.qr1.at",
        "phone": "004376543210",
        "status": ACTIVE",
        "apikey": "7bbc9930309e0f7760462e",
        "secret": "e3ec2ad6ad19b03f5ecd1f",
        "maxcampaigns": "1000",
        "maxlandingpages": "1000",
        "creationdate": "2025-04-01 21:05:44"
   }
}

Benutzer abrufen

Die Daten von einem Benutzer bekommen Sie, wenn Sie den Benutzernamen übergeben. 

https://white.qr1.at/api/admin/user/get?token=<SHOW API KEY>&loginname=adam

Das Ergebnis ist ein JSON notiertes Objekt mit den aktuellen Benutzerdaten. Das lastedit Feld gibt an, wann der Benutzer zuletzt eine Landing Page geändert hat. 

{ 
    "result":{
        "uid":"12345678",
        "loginname":"adam",
        "lastlogin":"2025-04-01 21:05:44",
        "lastedit": "2025-04-01 21:05:44",
        "firstname": "Adam",
        "lastname": "Sandler",
        "language": "en",
        "measurement": "METRIC",
        "timeformat": "24",
        "currency": "EUR",
        "email": "adam2@white.qr1.at",
        "phone": "004376543210",
        "company": "mein firma",
        "companyurl": "meinfirma.url",
        "street": "Strasse zum Mars",
        "city": "Marsian",
        "zip": "1011001",
        "state": "MS",
        "status": ACTIVE",
        "apikey": "7bbc9930309e0f7760462e",
        "secret": "e3ec2ad6ad19b03f5ecd1f",
        "updated": "2025-04-01 21:05:44"
   }
}

Alle Benutzer anzeigen

Der folgende Beispielaufruf liefert eine Liste von allen im System angelegten Benutzern:

https://white.qr1.at/api/admin/users?token=<SHOW API KEY>

Die Antwort enthält eine Liste aller Benutzer mit deren zugehörigen Basisdaten wie zum benutzer id, loginname, firstname, lastname, language, email, phone, company, companyurl, street, city, zip, state, country, status, apikey, secret, lastlogin und creationdate.

Optionale Parameter

  • output Wenn Sie diesen optionalen Parameter auf output=xlsx setzen, werden die Daten im Excel-Format zurückgegeben

{
    "result": {
        "users": [
            {
                "uid":"12345678",
                "loginname":"test",
                "firstname": "Richard",
                "lastname": "Pepperoni",
                "language": "de",
                "email": "test@white.qr1.at",
                "phone": "0043123456789",
                "company": "mein firma",
                "companyurl": "meinfirma.url",
                "street": "Strasse zum Mars",
                "city": "Marsian",
                "zip": "1011001",
                "state": "MS",
                "country": "Austria",
                "status": ACTIVE",
                "apikey": "10aff990b55ddb663c10441",
                "secret": "e3ec2ad6ad19b03f5ecd1f",
                "lastlogin": "2025-04-01 21:05:44",
                "creationdate": "2025-04-01 21:05:44"                
            },
            {
                "uid":"123456789",
                "loginname":"test2",
                "firstname": "Eva",
                "lastname": "Mandarini",
                "language": "de",
                "email": "eva@white.qr1.at",
                "phone": "004376543210",
                "company": "mein firma",
                "companyurl": "meinfirma.url",
                "street": "Strasse zum Mars",
                "city": "Marsian",
                "zip": "1011001",
                "state": "MS",
                "country": "USA",
                "status": ACTIVE",
                "apikey": "aa4922f289d5cc43ae93225",
                "secret": "408f75a8c0dada595208c5",
                "lastlogin": "2025-04-01 21:05:44",
                "creationdate": "2025-04-01 21:05:44"                
            },
        ]
    }
}

Benutzerrechte

Legen Sie für einen einzelnen User dessen Berechtigungen fest:

https://white.qr1.at/api/admin/user/permission?token=<SHOW API KEY>&
loginname=adam&<BERECHTIGUNG>=<WERT>
Berechtigung Wert Beschreibung
scheduler 0 oder 1 Wenn der Scheduler aktiviert wird, kann der User zeitgesteuerte Weiterleitungen zu einem dynamischen QR Code hinzufügen.
vanityurls 0 oder 1 Sind Vanity URLs aktiviert, kann jeder QR Code oder jede Landingpage mit einer eigenen URL versehen werden.
deleteurls 0 oder 1 Wenn diese Option aktiviert ist, können Benutzer alle angelegten QR Codes wieder löschen.
readonly 0 oder 1 Wenn diese Option aktiviert ist, können Benutzer von allen QR Codes nur die Scan Statistiken abfragen. Der Benutzer kann keine QR Codes anlegen oder editieren.
import 0 oder 1 Mit der Import Funktion können Landingpages und Kampagnen importiert werden.
gps 0 oder 1 Wenn GPS aktiviert ist, können QR Code Scans per GPS geortet werden.
api 0 oder 1 Wenn die API aktiviert ist, können QR Code programmatisch erstellt werden.
sms 0 oder 1 Wenn die SMS Funktion aktiviert ist, können Benutzer per SMS benachrichtigt werden, wenn der QR Code gescannt wurde. Ein Benutzer kann für jeden QR Code einzeln festlegen, ob er die SMS Benachrichtigung bei einem Scan erhalten möchte.
digitalmenu 0 oder 1 Wenn die digitale Speisekarte aktiviert ist, erscheint beim Anlegen eines QR Codes diese Option.
businesscards 0 .. 1000 Die maximale Anzahl an Visitenkarten die vom Benutzer erstellt werden dürfen.
products 0 .. 1000 Die maximale Anzahl an Produkten die vom Benutzer erstellt werden dürfen.
leads 0 .. 1000 Die maximale Anzahl an Lead Formularen die vom Benutzer erstellt werden dürfen.
realestates 0 .. 1000 Die maximale Anzahl an Immobilien die vom Benutzer erstellt werden dürfen.
coupons 0 .. 1000 Die maximale Anzahl an Gutscheinen die vom Benutzer erstellt werden dürfen.
plain 0 .. 1000 Die maximale Anzahl an frei gestaltbaren Landingpages die vom Benutzer erstellt werden dürfen.
social 0 .. 1000 Die maximale Anzahl an social Landing Pages die vom Benutzer erstellt werden dürfen.
tracing 0 .. 1000 Die maximale Anzahl an digitalen Gästelisten die vom Benutzer erstellt werden dürfen.

Wenn Sie die Anzahl für einen der Landingpage Typen (businesscards, products, ...) auf 0 setzen, werden diese automatisch deaktiviert und es können von diesem Typ keine Landingpages angelegt werden.

Benutzer bearbeiten

Bei einem bereits angelegten Benutzer können im Nachhinein

  • die Basisdaten firstname, lastname, email, currency, measurement, timeformat, company, companyurl, city, zip, street, state, phone oder password geändert werden
  • die Sprache language kann auf Deutsch de, Englisch en oder Spanisch es gesetzt werden
  • der Status kann entweder auf ACTIVE oder INACTIVE gesetzt werden. Inaktive Benutzer können sich nicht mehr auf der Plattform einloggen, QR Codes und Landingpages funktionieren aber weiter.
  • die maximale Anzahl an QR Codes maxcampaigns oder Landingpages maxlandingpages geändert werden.

Bitte verwenden Sie immer einen existierenden Benutzernamen: 

https://white.qr1.at/api/admin/user/edit?token=<SHOW API KEY>&loginname=adam&
password=newadmin2&firstname=Adam2&lastname=Sandler2&email=adam2@white.qr1.at&phone=004376543210&status=ACTIVE&language=de&maxcampaigns=100&maxlandingpages=100

Das Ergebnis ist wie oben ein JSON notiertes Objekt mit den aktualisierten Benutzerdaten: 

{ 
    "result":{
        "loginname":"adam",
        "firstname": "Adam2",
        "lastname": "Sandler2",
        "language": "de",
        "currency": "EUR",
        "maxlandingpages": "30",
        "maxcampaigns": "30",
        "measurement": "METRIC",
        "timeformat": "24",
        "email": "adam2@white.qr1.at",
        "phone": "004376543210",
        "status": ACTIVE",
        "apikey": "7bbc9930309e0f7760462e",
        "updated": "2025-04-01 21:05:44"
   }
}

Webhooks verwalten

Unter Angabe des Benutzernamens können dem Benutzer Webhooks zugewiesen oder entfernt werden.

Der Parameter type muss ein gültiger Webhook-Typ (VOUCHER_REDEEMED, VOUCHER_CREATED, VOUCHER_UPDATED, VOUCHER_EXPIRED, QR_CODE_CREATED, QR_CODE_SCANNED, QR_CODE_UPDATED, LEAD_CREATED, TRACING_CREATED, CALL_2_ACTION_BUTTON_CLICKED, JOB_FINISHED) sein. Der Parameter url muss eine öffentlich zugängliche URL sein. Ist der Parameter leer, wird der Webhook wieder gelöscht. 

https://white.qr1.at/api/admin/user/webhook?token=<SHOW API KEY>&loginname=adam&type=QR_CODE_CREATED&url=https://my.webhook.com/qrcodecreated

Alternativ können Sie Webhooks auch in einer Anfrage verketten, z. B.: 

https://white.qr1.at/api/admin/user/webhook?token=<SHOW API KEY>&loginname=adam&QR_CODE_CREATED=https://my.webhook.com/qrcodecreated&QR_CODE_UPDATED=https://my.webhook.com/qrcodeupdated

Benutzer Profil kopieren

Unter Angabe des Benutzernamens kann das Profil des angegebenen Benutzers auf das eines anderen kopiert werden. Das Profil umfasst die allgemeinen Benutzereinstellungen (Max. QR Codes, Max. Landingpages, Scheduling, Vanity URLs, API, Import, Sprache, QR Codes löschen, QR Codes erzeugen(readonly), Sticker Shop, SMS Alerts, Währung, Maßsystem) sowie den GPS Tracking Dialog und alle Webhooks.

Wenn Sie to auf ALL_USERS setzen, wird das Profil von from auf alle Benutzerprofile kopiert. Verwenden Sie diesen Wert mit Vorsicht, da alle existierenden Benutzerprofile überschrieben werden.

A user's profile include:

  • Max. QR Codes
  • Max. Landing Pages
  • Scheduling
  • Vanity URLs
  • API
  • Import
  • Sprache
  • Delete QR Codes
  • Erstellen/Editieren QR Codes
  • Sticker Shop
  • SMS Alerts
  • Währung
  • Masseinheiten
  • External Tracking
  • Berechtigungen
  • Landing Page Typen
  • GPS Tracking Dialog
  • Webhooks 

https://white.qr1.at/api/admin/user/copy/profile?token=<SHOW API KEY>&from=adam&to=eva

Benutzer löschen

Unter Angabe des Benutzernamens kann der Benutzer mit der folgenden Methode entfernt werden.

Bitte verwenden Sie diesen Aufruf mit Vorsicht: Es werden alle QR Codes, Tracking Daten und Landingpages des Benutzers gelöscht. 
https://white.qr1.at/api/admin/user/delete?token=<SHOW API KEY>&loginname=adam

Das Ergebnis enthält den gelöschten Benutzer als JSON Objekt. 

{ 
    "result":{
        "loginname":"adam",
        "firstname": "Adam2",
        "lastname": "Sandler2",
        "language": "de",
        "email": "adam2@white.qr1.at",
        "phone": "004376543210",
        "status": DELETED",
        "apikey": "7bbc9930309e0f7760462e",
        "deleted": "2025-04-01 21:05:44"
   }
}

Massen Benutzer Generator

Sie können mehrere Benutzer auch mit dem Massen Benutzer Generator anlegen.

Abrechnung von Benutzern

Wir unterstützen keine Abrechnung Ihrer Benutzer. Bitte verwenden Sie dazu Anbieter wie fastspring.com oder stripe.com welche wiederkehrende Zahlungsmodelle anbieten.

Statistik

Gesamtstatistik aller QR Codes

Liefert die Anzahl aller angelegten QR Codes, aller gescannten QR Codes und die Gesamtzahl aller Scans.

https://white.qr1.at/api/admin/stat?token=<SHOW API KEY>
{ 
  "result": {
    "number_short_urls": "41",
    "used_shorted_urls": "17",
    "number_redirects": "612378"
  }
}

QR Code and Landing Pages management

QR Code oder Landing Page duplizieren

Unter Angabe der Kurz URL url können Sie einen QR Code oder eine Landingpage (unterstützt werden: Visitenkarten, Gutscheine, Produkte, Neukundenakquise und eigene Landingpages) duplizieren. Mit dem optionalen Parameter user können Sie den User angeben, zu welchem der QR Code dupliziert wird. Weiters kann auch ein Name für die neue Kurz URL vanityurl vergeben werden. Optional können Sie auch einen neuen Titel title vergeben. 

https://white.qr1.at/api/admin/user/copy/url?token=<SHOW API KEY>&url=abc&user=adam&vanityurl=newvanity

Wenn Sie eine Visitenkarte duplizieren, können Sie optional das Profilbild mit kopieren indem Sie den Parameter cloneuserimage=1 hinzufügen.

QR Code zu anderem Benutzer verschieben

Unter Angabe der Kurz URL url und eines Benutzerkürzels user können Sie einen QR Code zu einem anderen Benutzerkonto verschieben. 

https://white.qr1.at/api/admin/user/move/url?token=<SHOW API KEY>&url=abc&user=adam

Benutzer definierte Variablen zuweisen

Unter Angabe der Kurz URL code können Sie einem QR Code ein Schlüssel-Werte Paar zuweisen. Die Schlüssel akzeptieren nur alphanumerische Werte und einen Unterstrich. 

https://white.qr1.at/api/admin/dataelements/push?token=<SHOW API KEY>&code=2k&key=firstname&value=Max

Code Beispiele

Remote Login

Wenn Sie möchten, dass ein Benutzer sich Remote von Ihrer Webseite aus einloggen kann, nutzen Sie folgende URL mit USERNAME und PASSWORD als Parameter: 

https://white.qr1.at/user/login?user=<USERNAME>&password=<PASSWORD>

oder folgendes HTML Form: 

<form action="https://white.qr1.at/user/login" method="POST">
    <label for="user">User: </label>
    <input id="user" name="user" />
    <label for="password">Password: </label>
    <input id="password" name="password" />
    <input type="submit" value="Submit" />
</form>

Einbindung der API mit PHP

Um eine Liste aller auf der Plattform angelegten Benutzer zu bekommen, verwenden Sie folgendes PHP Skript: 

<?php

    $apiUrl  = "https://white.qr1.at/api/admin";
    $token   = "<SHOW API KEY>";
    $jsonurl = "$apiUrl/users?token=$token";

    $json        = file_get_contents($jsonurl, 0, null, null);
    $json_output = json_decode($json);

?>
<table>
    <tr><th>User</th><th>API Key</th></tr>
    <?php
        foreach ($json_output->result->users as $user) {
            echo "<tr><td>{$user->loginname}</td><td>{$user->apikey}</td></tr>";
        }
    ?>
</table>

Um einen Benutzer anzulegen, können Sie unten stehendes PHP Skript verwenden. Beim ersten Aufruf wird der User angelegt. Wird die API Methode mit den selben Parametern noch einmal aufgerufen, kommt die Fehlermeldung, dass der Benutzer schon angelegt ist. 

<?php

$apiUrl   = "https://white.qr1.at/api/admin";
$token     = "<SHOW API KEY>";
$loginname = "adam";
$password  = "342adam$12";
$firstname = "Adman";
$lastname  = "Sandler";
$email     = "adam@white.qr1.at";
$phone     = "004312345678";

$jsonurl = 
        "$apiUrl/user/create?token=$token&".
        "loginname=$loginname&".
        "password=$password&".
        "firstname=$firstname&".
        "lastname=$lastname&".
        "email=$email&".
        "phone=$phone";

$json        = file_get_contents($jsonurl, 0, null, null);
$json_output = json_decode($json);
$error       = $json_output->result->error;

if (isset($error)) {
    echo "{$error->code}, {$error->message}";
} else {
    $user = $json_output->result;
    echo "{$user->loginname}, {$user->apikey}";
}
   
?>

Webhooks

Mit Webhooks können Sie ereignisbasierte Informationen an eine benutzerdefinierte URL senden. Wenn ein Ereignis, z.B. QR_CODE_SCANNED auftritt, wird Ihre angegebene URL aufgerufen (webhooked).

Mehr über Webhooks