QR-Codes

QR-Codes mit Logo, Farben, Stilen und Inhaltstypen erstellen, danach auflisten oder aktualisieren.

Unterstützte Typen

Übergeben Sie type als einen dieser Schlüssel. Inhaltsfelder ändern sich mit dem Typ.

text
url
phone
sms
email
whatsapp
facetime
location
wifi
event
vcard
crypto
paypal
upi
epc
pix

POST/api/v1/qr-codes

QR-Code erstellen

Senden Sie JSON im Anfragekörper. name und type sind Pflicht. Bei url-Typen übergeben Sie url. Ergänzen Sie style, Farben und qr_code_logo, um einen gestalteten Code aus dem Studio nachzubilden. Der Typ file ist über die API nicht verfügbar.

Name	Typ	Erforderlich	Standard	Beschreibung
name	string	Ja	—	Bezeichnung, die an der Ressource gespeichert wird.
type	string	Ja	url	Inhaltstyp. Einer der unterstützten QR-Schlüssel, außer file.
url	string	Nein	—	Ziel-URL. Erforderlich, wenn type url ist.
text	string	Nein	—	Klartext. Erforderlich, wenn type text ist. Für Massentext Zeilen in diesem Feld trennen.
url_dynamic	boolean	Nein	false	Wenn true, wird ein Kurzlink erzeugt und der QR kodiert diesen Link, damit das Ziel später geändert werden kann.
project_id	integer	Nein	—	Projekt, dem die Ressource zugeordnet wird.
is_bulk	boolean	Nein	false	Wenn true und type text ist, wird pro Zeile in text ein QR erzeugt.
style	string	Nein	square	Modulform. Beispiele: square, dot, rounded, heart, hexagon.
inner_eye_style	string	Nein	square	Form des inneren Suchermusters. Beispiele: square, dot, circle, rounded.
outer_eye_style	string	Nein	square	Form des äußeren Suchermusters. Beispiele: square, circle, rounded, flower.
size	integer	Nein	500	Bildgröße in Pixeln, 50–2000.
margin	integer	Nein	0	Ruhezonen-Module, 0–25.
ecc	string	Nein	M	Fehlerkorrektur: L, M, Q oder H. Verwenden Sie H, wenn Sie ein Logo hinzufügen.
foreground_type	string	Nein	color	color oder gradient.
foreground_color	string	Nein	#000000	Modulfarbe als HEX.
foreground_gradient_style	string	Nein	horizontal	vertical, horizontal, diagonal, inverse_diagonal oder radial.
foreground_gradient_one	string	Nein	—	Erste Verlaufs-HEX-Farbe.
foreground_gradient_two	string	Nein	—	Zweite Verlaufs-HEX-Farbe.
background_color	string	Nein	#ffffff	Hintergrund-HEX-Farbe. Heller halten als die Module.
background_color_transparency	integer	Nein	0	Hintergrundtransparenz, 0–100.
custom_eyes_color	boolean	Nein	false	Wenn true, verwenden die Augen eyes_inner_color und eyes_outer_color.
eyes_inner_color	string	Nein	#000000	HEX-Farbe des inneren Auges.
eyes_outer_color	string	Nein	#000000	HEX-Farbe des äußeren Auges.
qr_code_logo	string	Nein	—	Logo-Bild-URL oder hochgeladener Dateischlüssel.
qr_code_logo_size	number	Nein	25	Logogröße in Prozent des QR, 5–40.
frame	string	Nein	—	Optionaler Rahmenschlüssel aus dem Studio.
frame_text	string	Nein	—	Beschriftung auf dem Rahmen.

Inhaltsfelder nach Typ

Name	Typ	Erforderlich	Standard	Beschreibung
phone	string	Nein	—	Telefonnummer, wenn type phone ist.
sms	string	Nein	—	Telefonnummer, wenn type sms ist.
sms_body	string	Nein	—	SMS-Nachrichtentext.
email	string	Nein	—	Empfänger, wenn type email ist.
email_subject	string	Nein	—	E-Mail-Betreff.
email_body	string	Nein	—	E-Mail-Text.
whatsapp	string	Nein	—	WhatsApp-Nummer, nur Ziffern.
whatsapp_body	string	Nein	—	Vorausgefüllter WhatsApp-Text.
wifi_ssid	string	Nein	—	Netzwerkname, wenn type wifi ist.
wifi_password	string	Nein	—	WLAN-Passwort.
wifi_encryption	string	Nein	WPA	nopass, WEP, WPA oder WPA/WPA2.
location_latitude	number	Nein	—	Breitengrad, wenn type location ist.
location_longitude	number	Nein	—	Längengrad, wenn type location ist.
event	string	Nein	—	Ereignistitel, wenn type event ist.
event_start_datetime	string	Nein	—	ISO-DateTime für den Ereignisbeginn.
vcard first_name / last_name / email	string	Nein	—	vCard-Felder: first_name, last_name, email und die übrigen Studio-Schlüssel.

Anfragebeispiel

curl -X POST 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Website QR",
  "type": "url",
  "url": "https://forqrcode.com",
  "style": "rounded",
  "size": 500,
  "ecc": "M",
  "foreground_color": "#17191c",
  "background_color": "#ffffff",
  "qr_code_logo": "https://forqrcode.com/logo.png",
  "qr_code_logo_size": 25
}'

Weitere Beispiele

Verlaufs-QR

curl -X POST 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Gradient QR",
  "type": "url",
  "url": "https://forqrcode.com",
  "style": "dot",
  "inner_eye_style": "circle",
  "outer_eye_style": "rounded",
  "foreground_type": "gradient",
  "foreground_gradient_style": "radial",
  "foreground_gradient_one": "#5c8b29",
  "foreground_gradient_two": "#25492f",
  "background_color": "#ffffff",
  "size": 600
}'

WLAN-QR

curl -X POST 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Office Wi-Fi",
  "type": "wifi",
  "wifi_ssid": "Guest",
  "wifi_password": "correct-horse",
  "wifi_encryption": "WPA",
  "style": "square",
  "ecc": "H"
}'

Antwortbeispiel

{
  "data": {
    "id": 1,
    "type": "url",
    "name": "Website QR",
    "qr_code": "https://…/qr-codes/…/qr.svg",
    "settings": {
      "style": "rounded",
      "size": 500,
      "ecc": "M"
    }
  }
}

GET/api/v1/qr-codes

QR-Code auflisten

Name	Typ	Erforderlich	Beschreibung
page	integer	Nein	Page number (default 1)
results_per_page	integer	Nein	Items per page (default 25, max 100)
search	string	Nein	Search term
search_by	string	Nein	Column to search
order_by	string	Nein	Sort column
order_type	string	Nein	asc or desc
datetime_start	string	Nein	ISO datetime filter start
datetime_end	string	Nein	ISO datetime filter end
project_id	integer	Nein	—
type	string	Nein	—

curl -X GET 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/v1/qr-codes/{id}

Einen QR-Code lesen

Name	Typ	Erforderlich	Beschreibung
id	integer	Ja	—

curl -X GET 'https://forqrcode.com/api/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/v1/qr-codes/{id}

QR-Code aktualisieren

Name	Typ	Erforderlich	Standard	Beschreibung
id	integer	Ja	—	—
name	string	Nein	—	Bezeichnung, die an der Ressource gespeichert wird.
type	string	Nein	url	Inhaltstyp. Einer der unterstützten QR-Schlüssel, außer file.
url	string	Nein	—	Ziel-URL. Erforderlich, wenn type url ist.
text	string	Nein	—	Klartext. Erforderlich, wenn type text ist. Für Massentext Zeilen in diesem Feld trennen.
url_dynamic	boolean	Nein	false	Wenn true, wird ein Kurzlink erzeugt und der QR kodiert diesen Link, damit das Ziel später geändert werden kann.
project_id	integer	Nein	—	Projekt, dem die Ressource zugeordnet wird.
is_bulk	boolean	Nein	false	Wenn true und type text ist, wird pro Zeile in text ein QR erzeugt.
style	string	Nein	square	Modulform. Beispiele: square, dot, rounded, heart, hexagon.
inner_eye_style	string	Nein	square	Form des inneren Suchermusters. Beispiele: square, dot, circle, rounded.
outer_eye_style	string	Nein	square	Form des äußeren Suchermusters. Beispiele: square, circle, rounded, flower.
size	integer	Nein	500	Bildgröße in Pixeln, 50–2000.
margin	integer	Nein	0	Ruhezonen-Module, 0–25.
ecc	string	Nein	M	Fehlerkorrektur: L, M, Q oder H. Verwenden Sie H, wenn Sie ein Logo hinzufügen.
foreground_type	string	Nein	color	color oder gradient.
foreground_color	string	Nein	#000000	Modulfarbe als HEX.
foreground_gradient_style	string	Nein	horizontal	vertical, horizontal, diagonal, inverse_diagonal oder radial.
foreground_gradient_one	string	Nein	—	Erste Verlaufs-HEX-Farbe.
foreground_gradient_two	string	Nein	—	Zweite Verlaufs-HEX-Farbe.
background_color	string	Nein	#ffffff	Hintergrund-HEX-Farbe. Heller halten als die Module.
background_color_transparency	integer	Nein	0	Hintergrundtransparenz, 0–100.
custom_eyes_color	boolean	Nein	false	Wenn true, verwenden die Augen eyes_inner_color und eyes_outer_color.
eyes_inner_color	string	Nein	#000000	HEX-Farbe des inneren Auges.
eyes_outer_color	string	Nein	#000000	HEX-Farbe des äußeren Auges.
qr_code_logo	string	Nein	—	Logo-Bild-URL oder hochgeladener Dateischlüssel.
qr_code_logo_size	number	Nein	25	Logogröße in Prozent des QR, 5–40.
frame	string	Nein	—	Optionaler Rahmenschlüssel aus dem Studio.
frame_text	string	Nein	—	Beschriftung auf dem Rahmen.

Anfragebeispiel

curl -X PATCH 'https://forqrcode.com/api/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://forqrcode.com/pricing",
  "foreground_color": "#5d2a1a"
}'

DELETE/api/v1/qr-codes/{id}

QR-Code löschen

Name	Typ	Erforderlich	Beschreibung
id	integer	Ja	—

curl -X DELETE 'https://forqrcode.com/api/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Parameternamen und JSON-Beispiele sind auf Englisch. Ersetzen Sie YOUR_API_KEY durch Ihren Kontoschlüssel.