qr-code-api

QR Code API{JSON}

Über die API können Sie automatisiert QR Codes erzeugen und Statistiken über einen QR Code aufrufen, wie oft, wo und von welchen Geräten dieser gescannt wurde.
Als registrierter Benutzer können Sie über diese API auch noch zusätzliche Geo Informationen wie Longitude und Latitude dem QR Code hinzufügen. Ein mit einer Position verknüpfter Code ist ein geotagged QR Code.

Scannt jemand Ihren QR Code, den Sie an der abgespeicherten Adresse angebracht haben, wird dies in Echtzeit bei uns angezeigt. Auf dieser Landkarte finden Sie einen Überblick über bereits gescannte QR Codes.

Jeder API Aufruf liefert eine in JSON notierte Antwort.

Um die API verwenden zu können, registrieren Sie sich hier oder loggen sich hier ein.

QR Code erzeugen

Der folgende Aufruf erzeugt einen dynamischen QR Code für die übergebene URL:

https://api.qr1.at/short?key=<API_KEY_HIER_EINFÜGEN>&url=https://jungidee.at/projekte

Hinweis: Wenn Sie eine URL, die ein & enthält, übergeben wollen, verwenden Sie statt dem & den hexadezimalen Wert: %26. Wenn ein # in der zu URL vorkommt ersetzen Sie das Zeichen durch %23.

Das Ergebnis ist ein in JSON notiertes Objekt mit der gekürzten URL so wie dem QR Code:

{ 
    "result":{
      "id":"7W",
      "shorturl":"https://qr1.at/7W",
      "qr":"https://qr1.at/i/7W",
      "url":"https://jungidee.at/projekte",
      "creationdate":"2017-02-24 04:33:43",
      "image","",
      "location":{
         "address":"",
         "lng":"",
         "lat":"",
         "note":""
      }
   }
}

QR Code mit Geo Information taggen

Optional können zu jedem QR Code auch Geodaten abgespeichert werden. Das kann zum Beispiel der Firmenstandort der Webseite sein, oder eine beliebige Position, an der man den QR Code anbringt. Der Parameter address ist eine für den Menschen lesbare Adresse. Die Parameter lat (Latitude) und lng (Longitude) sind für die automatisierte Verarbeitung gedacht, z.B. um die Position auf einer Landkarte darzustellen. Der note Parameter kann verwendet werden, um optional eine genauere Beschreibung über den Standort anzugeben (z.B. Rechtes Türschild). Mit dem image Parameter können Sie den Pfad zu einem passenden Bild angeben.

https://api.qr1.at/short?key=<API_KEY_HIER_EINFÜGEN>&url=https://jungidee.at/contact&
address=Deublergasse 37&lng=16.3909&lat=48.2675&note=Türschild rechts

Das Ergebnis ist wie oben ein JSON notiertes Objekt mit zusätzlichen Geodaten:

{ 
    "result":{
      "id":"7W",
      "shorturl":"https://qr1.at/7W",
      "qr":"https://qr1.at/i/7W",
      "url":"https://jungidee.at/contact",
      "creationdate":"2017-02-24 04:33:43",
      "image","",
      "location":{
         "address":"Deublergasse 37",
         "lng":"16.3909",
         "lat":"48.2675",
         "note":"Türschild rechts"
      }
   }
}

Alle Geo Tagged QR Codes anzeigen

Der folgende Beispielaufruf liefert eine Liste von Ihren Geo Tagged QR Codes:

https://api.qr1.at/geotags?key=<API_KEY_HIER_EINFÜGEN>

Die Abfrage enthält eine Liste aller Geo Tagged QR Codes mit der Anzahl an Scans und eindeutigen Besuchern für jeden Code. Außerdem werden auch die Original URL und Addressdaten angezeigt.

{
    "result": {
        "geotags": [
            {
                "id":"3P",
                "shorturl": "https://qr1.at/3P",
                "qr": "https://qr1.at/i/3P",
                "url": "https://jungidee.at",
                "scans": "12",
                "uniquevisitors": "10",
                "creationdate": "2017-02-24 04:33:43",
                "image": "/u/3P.jpg",
                "location": {
                    "address": "Deublergasse 37, 1210 Wien, Österreich",
                    "lng": "16.3909",
                    "lat": "48.2675",
                    "note": "Haustüre rechts"
                }
            },
            {
                "id":"4L",
                "shorturl": "https://qr1.at/4L",
                "qr": "https://qr1.at/i/4L",
                "url": "https://qr1.at/l/kayiko",
                "scans": "17",
                "uniquevisitors": "10",
                "creationdate": "2016-10-12 13:08:38",
                "image": "/u/4L.jpg",
                "location": {
                    "address": "Windmühlgasse 16, 1060 Wien, Österreich",
                    "lng": "16.3566",
                    "lat": "48.1992",
                    "note": "An der Türe"
                }
            },
            {
                "id":"7k",
                "shorturl": "https://qr1.at/7k",
                "qr": "https://qr1.at/i/7k",
                "url": "http://www.map-studio.com",
                "scans": "0",
                "uniquevisitors": "0",
                "creationdate": "2016-10-27 21:26:23",
                "image": "",
                "location": {
                    "address": "Schönburgstraße 27, 1040 Wien, Österreich",
                    "lng": "16.3703",
                    "lat": "48.1864",
                    "note": "Rooftop"
                }
            },
            {
                "id":"7q",
                "shorturl": "https://qr1.at/7q",
                "qr": "https://qr1.at/i/7q",
                "url": "http://www.derstaud.at",
                "scans": "9",
                "uniquevisitors": "2",
                "creationdate": "2016-10-28 16:05:59",
                "image": "",
                "location": {
                    "address": "Eisstoßgasse 8, 1220 Wien, Österreich",
                    "lng": "16.4397",
                    "lat": "48.2178",
                    "note": "Garage"
                }
            }
        ]
    }
}

Tag Map Widget

Verwenden Sie das TagMap Widget um Ihre mit Geodaten verknüpften QR Codes auf einer Landkarte anzuzeigen. So sehen Sie immer wo und wie oft Ihre QR Codes gescannt wurden.

TagMap Widget Details...

Alle QR Codes anzeigen

Der folgende Beispielaufruf liefert eine Liste von Ihren QR Codes:

https://api.qr1.at/qrcodes?key=<API_KEY_HIER_EINFÜGEN>

Die Abfrage enthält eine Liste aller QR Codes mit der Anzahl an Scans und eindeutigen Besuchern für jeden Code. Außerdem werden auch die Original URL und Addressdaten angezeigt.

{
        "result": {
            "qrcodes": [
                {
                    "id":"3P",
                    "shorturl": "https://qr1.at/3P",
                    "qr": "https://qr1.at/i/3P",
                    "title":"title of target website",
                    "description":"description of target website",
                    "type": "URL",
                    "url": "https://qr1.at/test",
                    "scans": "12",
                    "uniquevisitors": "10",
                    "creationdate": "2016-10-08 22:19:48",
                    "image": "/u/3P.jpg",
                    "location": {
                        "address": "my street 37, 38721 Berlin, Germany",
                        "lng": "16.3909",
                        "lat": "48.2675"
                    }
                },
                {
                    "id":"4L",
                    "shorturl": "https://qr1.at/4L",
                    "qr": "https://qr1.at/i/4L",
                    "title":"title of target website",
                    "description":"description of target website",
                    "type": "URL",
                    "url": "https://qr1.at/test",
                    "scans": "17",
                    "uniquevisitors": "10",
                    "creationdate": "2016-10-12 13:08:38",
                    "image": "/u/4L.jpg",
                    "location": {
                        "address": "Downtown 1, 1010 Vienna, Austria",
                        "lng": "16.3566",
                        "lat": "48.1992"
                    }
                }
            ]
        }
    }

Scan Statistiken für einen QR Code abfragen

Der nachfolgende Aufruf ist ein Beispiel zur Auswertung der Scan Statistiken eines QR Codes. Als Eingabeparameter übergeben Sie die ID des QR Codes und den API Key:

https://api.qr1.at/stat?key=<API_KEY_HIER_EINFÜGEN>&id=7W

Das Ergebnis zeigt zuerst allgemeine Informationen: Original URL, gekürzte URL, Link zum QR Code, Adresse und Geo Koordinaten. Danach folgen statistische Kennzahlen: Wann wurde der QR Code zum ersten und letzten Mal aufgerufen, wie viel Zeit ist dazwischen vergangen, wie oft ist er am Tag aufgerufen worden, das Alter in Tagen, Anzahl der eindeutigen Besucher und die Anzahl aller Aufrufe.
Pro Aufruf eines QR Codes werden das Aufrufdatum, das Land, das Bundesland, welcher Browser und dessen Version, welches Betriebssystem und welches Model bzw. welche Marke, (falls der QR Code mit einem mobilen Gerät gescannt wurde) gespeichert. Sendet der User beim Scannen des QR Codes seine Position mit, wird diese als lng & lat angezeigt.

{
   "result":{
      "id":"7W",
      "shorturl":"https://qr1.at/7W",
      "qr":"https://qr1.at/i/7W",
      "url":"https://jungidee.at",
      "creationdate":"2016-10-08 22:19:48",
      "image","",
      "location":{
         "address":"Deublergasse 37, 1210 Wien, Österreich",
         "lng":"16.3909",
         "lat":"48.2675",
         "note":"Haustüre rechts"
      },
      "firstrequestdate":"2016-10-09 10:32:35",
      "lastrequestdate":"2016-10-09 20:45:36",
      "daysbetweenfirstandlastrequest":"1",
      "dayssincecreated":"3",
      "uniqevisitors":"4",
      "callsperday":"9",
      "requestcount":"9",
      "requests":[         
         {
            "requestdate":"2016-10-09 10:59:41",
            "region":"New York",
            "countrycode":"us",
            "country":"United States",
            "lng":"",
            "lat":"",
            "browser":"BlackBerry",
            "browserversion":"5",
            "os":"RIM OS",
            "model":"BlackBerry 9700",
            "brand":"RIM"
         },
         {
            "requestdate":"2016-10-09 10:59:40",
            "region":"Sunnyvale",
            "countrycode":"us",
            "country":"United States",
            "lng":"",
            "lat":"",
            "browser":"MSIE",
            "browserversion":"7",
            "os":"Windows",
            "model":"",
            "brand":""
         },
         {
            "requestdate":"2016-10-09 10:57:03",
            "region":"Niederösterreich",
            "countrycode":"at",
            "country":"Austria",
            "lng":"16.4184",
            "lat":"48.185",
            "browser":"Safari",
            "browserversion":"",
            "os":"iPhone OS",
            "model":"iPhone",
            "brand":"Apple"
         },
         {
            "requestdate":"2016-10-09 10:32:35",
            "region":"Niederösterreich",
            "countrycode":"at",
            "country":"Austria",
            "lng":"",
            "lat":"",
            "browser":"Firefox",
            "browserversion":"6",
            "os":"Windows",
            "model":"",
            "brand":""
         }
      ]
   }
}

API Aufrufe mit Javascript

QR Code erzeugen

Sie können die API direkt mit Javascript (jQuery.getJSON) ansprechen. Binden Sie folgendes Code Snippet auf Ihrer Webseite ein, um einen QR Code zu erstellen:

<script src="http://code.jquery.com/jquery.min.js"></script>
<script type="text/javascript">
    
var url = "https://jungidee.at/home";

var apiKey = "<API_KEY_HIER_EINFÜGEN>";
var apiUrl = "https://api.qr1.at/";

/**
 * Beispiel API Aufruf zum Erzeugen eines QR Codes.
 * wichtig ist der Parameter &callback=? am Ende des Requests.
 * Dieser Parameter wird von jQuery.getJSON verwendet um nach dem Aufruf 
 * die untenstehende Callback Funktion aufzurufen.
 */
var apiShortUrl = apiUrl + "short?key=" + apiKey + "&url=" + url + "&callback=?";

/*
 * Callback Funktion, die von der API aufgerufen wird, nachdem QR Code erzeugt worden ist.
 * Diese Funktion sollte immer so heißen, wie die Methode des API Aufrufes.
 * Das zurückgelieferte JSON Objekt kann mit data.result angesprochen werden.         
 * (z.B. data.result.shorturl, data.result.creationdate, usw.)
 */
function short(data) {
    $('#result').html("Der QR Code wurde erzeugt und die Url '" +
                       url + 
                      "' wurde gekürzt zu " + data.result.shorturl +
                      "<img src='"+ data.result.qr +"'/>");
}

$(function() {
    $('#shortenUrl').click(function() {
        // Aufruf der API um einen QR Code zu erstellen.
        $.getJSON(apiShortUrl);
    });
});
</script>
<div>
    Klicken Sie <a href="#" id="shortenUrl">hier</a> 
    um für die URL https://jungidee.at/home mit der API einen QR Code anzulegen.
</div>
<div id="result"></div>
        

Premium API

Mit der API von einem Premium oder White Label Konto können Sie mit einem geheimen API Schlüssel die Ziel URLs von QR Codes editieren oder vorhandene QR Codes löschen. Sie können auch alternative Informationen wie Beschreibung oder Titel beim Anlegen eines QR Codes setzen. Außerdem haben Sie die Möglichkeit, die GPS Tracking Funktion über die API zu aktivieren oder die Benachrichtigungsfunktion, wenn ein QR Code aufgerufen wird, einzuschalten.

Als Administrator der White Label Plattform können Sie auch über die User-API Benutzer anlegen und bearbeiten. Sie können ein Premium Konto 30 Tage unverbindlich und kostenlos testen.

Top