QR-koodit

Luo QR-koodeja logolla, väreillä, tyyleillä ja sisältötyypeillä, sitten listaa tai päivitä ne.

Tuetut tyypit

Anna type yhtenä näistä avaimista. Sisältökentät vaihtuvat tyypin mukaan.

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

POST/api/v1/qr-codes

Luo QR-koodi

Lähetä JSON pyynnön rungossa. name ja type ovat pakollisia. url-tyypeille anna url. Lisää style, värit ja qr_code_logo vastaamaan studion suunnittelemaa koodia. file-tyyppi ei ole käytössä APIssa.

Nimi	Tyyppi	Pakollinen	Oletus	Kuvaus
name	string	Kyllä	—	Resurssiin tallennettu nimiö.
type	string	Kyllä	url	Sisältötyyppi. Yksi tuetuista QR-avaimista, ei file.
url	string	Ei	—	Kohde-URL. Pakollinen, kun type on url.
text	string	Ei	—	Pelkkä teksti. Pakollinen, kun type on text. Joukkotekstissä erota rivit tässä kentässä.
url_dynamic	boolean	Ei	false	Jos true, luodaan lyhytlinkki ja QR koodaa sen, jotta kohdetta voi vaihtaa myöhemmin.
project_id	integer	Ei	—	Projekti, johon resurssi liitetään.
is_bulk	boolean	Ei	false	Jos true ja type on text, jokaisesta text-rivistä luodaan yksi QR.
style	string	Ei	square	Modulin muoto. Esimerkkejä: square, dot, rounded, heart, hexagon.
inner_eye_style	string	Ei	square	Sisemmän etsintäkuvion muoto. Esimerkkejä: square, dot, circle, rounded.
outer_eye_style	string	Ei	square	Ulomman etsintäkuvion muoto. Esimerkkejä: square, circle, rounded, flower.
size	integer	Ei	500	Kuvan koko pikseleinä, 50–2000.
margin	integer	Ei	0	Hiljaisen vyöhykkeen modulit, 0–25.
ecc	string	Ei	M	Virheenkorjaus: L, M, Q tai H. Käytä H:ta, kun lisäät logon.
foreground_type	string	Ei	color	color tai gradient.
foreground_color	string	Ei	#000000	Modulin väri HEX-muodossa.
foreground_gradient_style	string	Ei	horizontal	vertical, horizontal, diagonal, inverse_diagonal tai radial.
foreground_gradient_one	string	Ei	—	Ensimmäinen liukuvärin HEX-väri.
foreground_gradient_two	string	Ei	—	Toinen liukuvärin HEX-väri.
background_color	string	Ei	#ffffff	Taustan HEX-väri. Pidä se modulia vaaleampana.
background_color_transparency	integer	Ei	0	Taustan läpinäkyvyys, 0–100.
custom_eyes_color	boolean	Ei	false	Jos true, silmät käyttävät eyes_inner_color- ja eyes_outer_color-arvoja.
eyes_inner_color	string	Ei	#000000	Sisemmän silmän HEX-väri.
eyes_outer_color	string	Ei	#000000	Ulomman silmän HEX-väri.
qr_code_logo	string	Ei	—	Logokuvan URL tai ladatun tiedoston avain.
qr_code_logo_size	number	Ei	25	Logon koko prosentteina QR:stä, 5–40.
frame	string	Ei	—	Valinnainen kehyksen avain studiosta.
frame_text	string	Ei	—	Kehykseen piirretty kuvateksti.

Sisältökentät tyypeittäin

Nimi	Tyyppi	Pakollinen	Oletus	Kuvaus
phone	string	Ei	—	Puhelinnumero, kun type on phone.
sms	string	Ei	—	Puhelinnumero, kun type on sms.
sms_body	string	Ei	—	SMS-viestin runko.
email	string	Ei	—	Vastaanottaja, kun type on email.
email_subject	string	Ei	—	Sähköpostin aihe.
email_body	string	Ei	—	Sähköpostin runko.
whatsapp	string	Ei	—	WhatsApp-numero, vain numerot.
whatsapp_body	string	Ei	—	Valmiiksi täytetty WhatsApp-teksti.
wifi_ssid	string	Ei	—	Verkon nimi, kun type on wifi.
wifi_password	string	Ei	—	Wi-Fi-salasana.
wifi_encryption	string	Ei	WPA	nopass, WEP, WPA tai WPA/WPA2.
location_latitude	number	Ei	—	Leveysaste, kun type on location.
location_longitude	number	Ei	—	Pituusaste, kun type on location.
event	string	Ei	—	Tapahtuman otsikko, kun type on event.
event_start_datetime	string	Ei	—	ISO-päiväaika tapahtuman alulle.
vcard first_name / last_name / email	string	Ei	—	vCard-kentät: first_name, last_name, email ja muut studioavaimet.

Pyyntöesimerkki

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

Lisää esimerkkejä

Liukuväri-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"
}'

Vastausesimerkki

{
  "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

Listaa QR-koodi

Nimi	Tyyppi	Pakollinen	Kuvaus
page	integer	Ei	Page number (default 1)
results_per_page	integer	Ei	Items per page (default 25, max 100)
search	string	Ei	Search term
search_by	string	Ei	Column to search
order_by	string	Ei	Sort column
order_type	string	Ei	asc or desc
datetime_start	string	Ei	ISO datetime filter start
datetime_end	string	Ei	ISO datetime filter end
project_id	integer	Ei	—
type	string	Ei	—

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

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

Lue yksi QR-koodi

Nimi	Tyyppi	Pakollinen	Kuvaus
id	integer	Kyllä	—

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

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

Päivitä QR-koodi

Nimi	Tyyppi	Pakollinen	Oletus	Kuvaus
id	integer	Kyllä	—	—
name	string	Ei	—	Resurssiin tallennettu nimiö.
type	string	Ei	url	Sisältötyyppi. Yksi tuetuista QR-avaimista, ei file.
url	string	Ei	—	Kohde-URL. Pakollinen, kun type on url.
text	string	Ei	—	Pelkkä teksti. Pakollinen, kun type on text. Joukkotekstissä erota rivit tässä kentässä.
url_dynamic	boolean	Ei	false	Jos true, luodaan lyhytlinkki ja QR koodaa sen, jotta kohdetta voi vaihtaa myöhemmin.
project_id	integer	Ei	—	Projekti, johon resurssi liitetään.
is_bulk	boolean	Ei	false	Jos true ja type on text, jokaisesta text-rivistä luodaan yksi QR.
style	string	Ei	square	Modulin muoto. Esimerkkejä: square, dot, rounded, heart, hexagon.
inner_eye_style	string	Ei	square	Sisemmän etsintäkuvion muoto. Esimerkkejä: square, dot, circle, rounded.
outer_eye_style	string	Ei	square	Ulomman etsintäkuvion muoto. Esimerkkejä: square, circle, rounded, flower.
size	integer	Ei	500	Kuvan koko pikseleinä, 50–2000.
margin	integer	Ei	0	Hiljaisen vyöhykkeen modulit, 0–25.
ecc	string	Ei	M	Virheenkorjaus: L, M, Q tai H. Käytä H:ta, kun lisäät logon.
foreground_type	string	Ei	color	color tai gradient.
foreground_color	string	Ei	#000000	Modulin väri HEX-muodossa.
foreground_gradient_style	string	Ei	horizontal	vertical, horizontal, diagonal, inverse_diagonal tai radial.
foreground_gradient_one	string	Ei	—	Ensimmäinen liukuvärin HEX-väri.
foreground_gradient_two	string	Ei	—	Toinen liukuvärin HEX-väri.
background_color	string	Ei	#ffffff	Taustan HEX-väri. Pidä se modulia vaaleampana.
background_color_transparency	integer	Ei	0	Taustan läpinäkyvyys, 0–100.
custom_eyes_color	boolean	Ei	false	Jos true, silmät käyttävät eyes_inner_color- ja eyes_outer_color-arvoja.
eyes_inner_color	string	Ei	#000000	Sisemmän silmän HEX-väri.
eyes_outer_color	string	Ei	#000000	Ulomman silmän HEX-väri.
qr_code_logo	string	Ei	—	Logokuvan URL tai ladatun tiedoston avain.
qr_code_logo_size	number	Ei	25	Logon koko prosentteina QR:stä, 5–40.
frame	string	Ei	—	Valinnainen kehyksen avain studiosta.
frame_text	string	Ei	—	Kehykseen piirretty kuvateksti.

Pyyntöesimerkki

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}

Poista QR-koodi

Nimi	Tyyppi	Pakollinen	Kuvaus
id	integer	Kyllä	—

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

Parametrien nimet ja JSON-esimerkit näytetään englanniksi. Korvaa YOUR_API_KEY tilisi avaimella.