QR-kódok

Hozzon létre QR-kódokat logóval, színekkel, stílusokkal és tartalomtípusokkal, majd listázza vagy frissítse őket.

Támogatott típusok

A type legyen ezen kulcsok egyike. A tartalommezők a típussal változnak.

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

POST/api/v1/qr-codes

QR-kód létrehozása

Küldjön JSON-t a kérés törzsében. A name és a type kötelező. url típusoknál adja meg az url mezőt. Adjon hozzá style-t, színeket és qr_code_logo-t a stúdióban tervezett kódhoz. A file típus nem elérhető az API-n.

Név	Típus	Kötelező	Alapértelmezett	Leírás
name	string	Igen	—	Az erőforráson mentett címke.
type	string	Igen	url	Tartalomtípus. Egy a támogatott QR-kulcsok közül, a file kivételével.
url	string	Nem	—	Cél URL. Kötelező, ha a type url.
text	string	Nem	—	Egyszerű szöveg. Kötelező, ha a type text. Tömeges szövegnél a sorokat ebben a mezőben válassza el.
url_dynamic	boolean	Nem	false	Ha true, rövid link jön létre, és a QR ezt kódolja, így a cél később módosítható.
project_id	integer	Nem	—	Projekt, amelyhez az erőforrás csatolható.
is_bulk	boolean	Nem	false	Ha true és a type text, a text minden sorához egy QR készül.
style	string	Nem	square	Modulforma. Példák: square, dot, rounded, heart, hexagon.
inner_eye_style	string	Nem	square	Belső keresőminta formája. Példák: square, dot, circle, rounded.
outer_eye_style	string	Nem	square	Külső keresőminta formája. Példák: square, circle, rounded, flower.
size	integer	Nem	500	Képméret pixelben, 50–2000.
margin	integer	Nem	0	Nyugodt zóna modulok, 0–25.
ecc	string	Nem	M	Hibajavítás: L, M, Q vagy H. Logó esetén használjon H-t.
foreground_type	string	Nem	color	color vagy gradient.
foreground_color	string	Nem	#000000	Modulszín HEX-ben.
foreground_gradient_style	string	Nem	horizontal	vertical, horizontal, diagonal, inverse_diagonal vagy radial.
foreground_gradient_one	string	Nem	—	Első színátmenet HEX színe.
foreground_gradient_two	string	Nem	—	Második színátmenet HEX színe.
background_color	string	Nem	#ffffff	Háttér HEX színe. Legyen világosabb a moduloknál.
background_color_transparency	integer	Nem	0	Háttér átlátszósága, 0–100.
custom_eyes_color	boolean	Nem	false	Ha true, a szemek az eyes_inner_color és eyes_outer_color értékeket használják.
eyes_inner_color	string	Nem	#000000	Belső szem HEX színe.
eyes_outer_color	string	Nem	#000000	Külső szem HEX színe.
qr_code_logo	string	Nem	—	Logóképek URL-je vagy feltöltött fájlkulcs.
qr_code_logo_size	number	Nem	25	Logóméret a QR százalékában, 5–40.
frame	string	Nem	—	Opcionális keretkulcs a stúdióból.
frame_text	string	Nem	—	A keretre rajzolt felirat.

Tartalommezők típusonként

Név	Típus	Kötelező	Alapértelmezett	Leírás
phone	string	Nem	—	Telefonszám, ha a type phone.
sms	string	Nem	—	Telefonszám, ha a type sms.
sms_body	string	Nem	—	Az SMS üzenet törzse.
email	string	Nem	—	Címzett, ha a type email.
email_subject	string	Nem	—	E-mail tárgy.
email_body	string	Nem	—	E-mail törzs.
whatsapp	string	Nem	—	WhatsApp-szám, csak számjegyek.
whatsapp_body	string	Nem	—	Előre kitöltött WhatsApp-szöveg.
wifi_ssid	string	Nem	—	Hálózatnév, ha a type wifi.
wifi_password	string	Nem	—	Wi-Fi jelszó.
wifi_encryption	string	Nem	WPA	nopass, WEP, WPA vagy WPA/WPA2.
location_latitude	number	Nem	—	Szélesség, ha a type location.
location_longitude	number	Nem	—	Hosszúság, ha a type location.
event	string	Nem	—	Esemény címe, ha a type event.
event_start_datetime	string	Nem	—	ISO dátum-idő az esemény kezdetéhez.
vcard first_name / last_name / email	string	Nem	—	vCard mezők: first_name, last_name, email és a többi stúdiókulcs.

Példa kérés

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
}'

További példák

Színátmenetes 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
}'

Wi-Fi 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"
}'

Válaszpélda

{
  "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-kód listázása

Név	Típus	Kötelező	Leírás
page	integer	Nem	Page number (default 1)
results_per_page	integer	Nem	Items per page (default 25, max 100)
search	string	Nem	Search term
search_by	string	Nem	Column to search
order_by	string	Nem	Sort column
order_type	string	Nem	asc or desc
datetime_start	string	Nem	ISO datetime filter start
datetime_end	string	Nem	ISO datetime filter end
project_id	integer	Nem	—
type	string	Nem	—

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

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

Egy QR-kód olvasása

Név	Típus	Kötelező	Leírás
id	integer	Igen	—

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

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

QR-kód frissítése

Név	Típus	Kötelező	Alapértelmezett	Leírás
id	integer	Igen	—	—
name	string	Nem	—	Az erőforráson mentett címke.
type	string	Nem	url	Tartalomtípus. Egy a támogatott QR-kulcsok közül, a file kivételével.
url	string	Nem	—	Cél URL. Kötelező, ha a type url.
text	string	Nem	—	Egyszerű szöveg. Kötelező, ha a type text. Tömeges szövegnél a sorokat ebben a mezőben válassza el.
url_dynamic	boolean	Nem	false	Ha true, rövid link jön létre, és a QR ezt kódolja, így a cél később módosítható.
project_id	integer	Nem	—	Projekt, amelyhez az erőforrás csatolható.
is_bulk	boolean	Nem	false	Ha true és a type text, a text minden sorához egy QR készül.
style	string	Nem	square	Modulforma. Példák: square, dot, rounded, heart, hexagon.
inner_eye_style	string	Nem	square	Belső keresőminta formája. Példák: square, dot, circle, rounded.
outer_eye_style	string	Nem	square	Külső keresőminta formája. Példák: square, circle, rounded, flower.
size	integer	Nem	500	Képméret pixelben, 50–2000.
margin	integer	Nem	0	Nyugodt zóna modulok, 0–25.
ecc	string	Nem	M	Hibajavítás: L, M, Q vagy H. Logó esetén használjon H-t.
foreground_type	string	Nem	color	color vagy gradient.
foreground_color	string	Nem	#000000	Modulszín HEX-ben.
foreground_gradient_style	string	Nem	horizontal	vertical, horizontal, diagonal, inverse_diagonal vagy radial.
foreground_gradient_one	string	Nem	—	Első színátmenet HEX színe.
foreground_gradient_two	string	Nem	—	Második színátmenet HEX színe.
background_color	string	Nem	#ffffff	Háttér HEX színe. Legyen világosabb a moduloknál.
background_color_transparency	integer	Nem	0	Háttér átlátszósága, 0–100.
custom_eyes_color	boolean	Nem	false	Ha true, a szemek az eyes_inner_color és eyes_outer_color értékeket használják.
eyes_inner_color	string	Nem	#000000	Belső szem HEX színe.
eyes_outer_color	string	Nem	#000000	Külső szem HEX színe.
qr_code_logo	string	Nem	—	Logóképek URL-je vagy feltöltött fájlkulcs.
qr_code_logo_size	number	Nem	25	Logóméret a QR százalékában, 5–40.
frame	string	Nem	—	Opcionális keretkulcs a stúdióból.
frame_text	string	Nem	—	A keretre rajzolt felirat.

Példa kérés

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-kód törlése

Név	Típus	Kötelező	Leírás
id	integer	Igen	—

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

A paraméternevek és JSON-példák angolul jelennek meg. Cserélje a YOUR_API_KEY értéket a fiókkulcsára.