Entwickler QR-Code API-Leitfaden

API-Schlüssel

Der API-Schlüssel für dein Konto kann auf der Kontoseite erstellt werden. Der API-Schlüssel kann entweder als URL-Parameter in Anfragen eingebunden werden, z. B.: https://genqrcode.com/api/public/generate?apikey=YOUR_API_KEY, oder im `GenQRCode-apikey`-Header. In diesem Leitfaden gehen wir davon aus, dass der Header verwendet wird, da dies die sicherere Option ist. Beide Methoden sind jedoch austauschbar nutzbar. Der API-Schlüssel sollte als geheim betrachtet und nicht weitergegeben werden.

Ratenbegrenzung

Die Ratenbegrenzung wird durchgesetzt, um eine faire Nutzung der API sicherzustellen. Die kostenlose Stufe umfasst 180 Tokens pro Stunde. Normale QR-Codes kosten jeweils 1 Token, mit einem maximalen Stundenlimit von 180 Tokens, was einem QR-Code alle 20 Sekunden entspricht. Zusätzlich kosten die schnellen Endpunkte nur 1/50 eines Tokens, was 2,5 QR-Codes pro Sekunde entspricht. Diese schnellen Endpunkte werden empfohlen, wenn keine Anpassung des QR-Codes erforderlich ist. Wenn das Token-Limit überschritten wird, wird ein Statuscode 429 zurückgegeben, der anzeigt, dass die Anfrage begrenzt wurde.

Die Nutzung mehrerer Konten zur Umgehung dieser Limits ist verboten. Falls höhere Limits benötigt werden, kontaktiere uns bitte für die Preisgestaltung.

Bibliotheken

Java Library

Statische QR-Code-API

Beispiel Text-QR-Code

URL	https://api.genqrcode.com/public/generate
Anfragemethode	POST
Header	GenQRCode-apikey: API_KEY
Anfrageinhalt	{ "type": 0, "text": "https://genqrcode.com" }
Antwort

Beispiel WLAN-QR-Code

URL	https://api.genqrcode.com/public/generate
Anfragemethode	POST
Header	GenQRCode-apikey: API_KEY
Anfrageinhalt	{ "type": 1, "network": "GenQRCode", "password": false, "hidden": false, "encryption": "wpa" }
Antwort

Beispiel Farb-QR-Code

URL	https://api.genqrcode.com/public/generate
Anfragemethode	POST
Header	GenQRCode-apikey: API_KEY
Anfrageinhalt	{ "type": 0, "text": "https://genqrcode.com", "color": "#ff0000", "background_color": "#aaffaa", "inner_eye_color": "#ffaaaa", "outer_eye_color": "#ffaaff" }
Antwort

Beispiel Farb-Muster-QR-Code

URL	https://api.genqrcode.com/public/generate
Anfragemethode	POST
Header	GenQRCode-apikey: API_KEY
Anfrageinhalt	{ "type": 0, "text": "https://genqrcode.com", "color": "#e81416,#faeb36,#79c314,#487de7,#4b369d,#70369d", "custom_color_pattern": "1,1,2,2,3,3,4,4,5,5,6,6" }
Antwort

Rahmen-, Form- und Logo-Parameter

Hier werden alle anpassbaren Rahmen-, Form- und Logo-Parameter beschrieben und wie sie verwendet werden können.

Parameter	Typ	Standardwert	Beschreibung
style	Int	0	Stil der QR-Code-Quadrate. 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
inner_eye_style	Int	0	Stil der inneren Augen des QR-Codes. 0 1 2 3 4 5 6 7
outer_eye_style	Int	0	Stil der äußeren Augen des QR-Codes. 0 1 2 3 4 5 6
frame_style	Int	0	Stil des Rahmens um den QR-Code. 0 1 2 3 4 5 6 7 8 9 10 11 12 13
frame_text	String	SCAN ME	Der Text im Rahmen. Ein Rahmen mit Text muss konfiguriert werden, bevor dies sichtbar wird.
logo	String		Das Logo, das im QR-Code verwendet werden soll. youtube wifi google-maps facebook spotify threads zoom instagram linkedin genqrcode google-drive airbnb skype snapchat twitter x-twitter reddit
logo_remove_background	Boolean	false	Ob der Hintergrund hinter dem Logo entfernt werden soll.

Beispiel Logo- und Form-QR-Code

URL	https://api.genqrcode.com/public/generate
Anfragemethode	POST
Header	GenQRCode-apikey: API_KEY
Anfrageinhalt	{ "type": 0, "text": "https://x.com/genqrcode", "style": 22, "inner_eye_style": 1, "outer_eye_style": 4, "frame": 10, "frame_text": "My X Page", "logo": "x-twitter", "logo_remove_background":true }
Antwort

Schnelle QR-Code-API

Die schnelle QR-Code-API kostet nur 1/50 der Tokens der normalen API. Die QR-Codes sind für Geschwindigkeit und geringe Dateigröße optimiert. Während sie alle QR-Code-Typen unterstützt, sind nur wenige Anpassungsparameter verfügbar.

Beispiel Schneller Text-QR-Code

URL	https://api.genqrcode.com/public/fastgenerate
Anfragemethode	POST
Header	GenQRCode-apikey: API_KEY
Anfrageinhalt	{ "imageformat": "png", "type": 0, "text": "https://genqrcode.com" }
Antwort

Schnelle Batch-QR-Code-API

{
  "QR Code 1": {
    "text": "https://genqrcode.com",
    "type": 0,
    "width": 500,
    "bordersize": 4,
    "imageformat": "png",
    "height": 500
  },
  "QR Code 2": {
    "text": "https://genqrcode.com/dynamicview",
    "type": 0,
    "width": 500,
    "bordersize": 4,
    "imageformat": "png",
    "height": 500
  },
  "QR Code 3": {
    "text": "https://genqrcode.com/pricing",
    "type": 0,
    "width": 500,
    "bordersize": 4,
    "imageformat": "png",
    "height": 500
  }
}