QR-koder

Skapa QR-koder med logotyp, färger, stilar och innehållstyper, sedan lista eller uppdatera dem.

Stödda typer

Skicka type som en av dessa nycklar. Innehållsfält ändras med typen.

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

POST/api/v1/qr-codes

Skapa QR-kod

Skicka JSON i förfrågans kropp. name och type krävs. För url-typer skickar du url. Lägg till style, färger och qr_code_logo för att matcha en designad kod från studion. Typen file finns inte i API:t.

Namn	Typ	Obligatorisk	Standard	Beskrivning
name	string	Ja	—	Etikett som sparas på resursen.
type	string	Ja	url	Innehållstyp. En av de stödda QR-nycklarna, utom file.
url	string	Nej	—	Mål-URL. Krävs när type är url.
text	string	Nej	—	Vanlig text. Krävs när type är text. För masstext, separera rader i det här fältet.
url_dynamic	boolean	Nej	false	Om true skapas en kort länk och QR-koden kodar den länken så att målet kan ändras senare.
project_id	integer	Nej	—	Projekt att koppla resursen till.
is_bulk	boolean	Nej	false	Om true och type är text skapas en QR per rad i text.
style	string	Nej	square	Modulform. Exempel: square, dot, rounded, heart, hexagon.
inner_eye_style	string	Nej	square	Inre sökarmönsterform. Exempel: square, dot, circle, rounded.
outer_eye_style	string	Nej	square	Yttre sökarmönsterform. Exempel: square, circle, rounded, flower.
size	integer	Nej	500	Bildstorlek i pixlar, 50–2000.
margin	integer	Nej	0	Tystzonsmoduler, 0–25.
ecc	string	Nej	M	Felkorrigering: L, M, Q eller H. Använd H när du lägger till en logotyp.
foreground_type	string	Nej	color	color eller gradient.
foreground_color	string	Nej	#000000	Modulfärg som HEX.
foreground_gradient_style	string	Nej	horizontal	vertical, horizontal, diagonal, inverse_diagonal eller radial.
foreground_gradient_one	string	Nej	—	Första gradient-HEX-färgen.
foreground_gradient_two	string	Nej	—	Andra gradient-HEX-färgen.
background_color	string	Nej	#ffffff	Bakgrunds-HEX-färg. Håll den ljusare än modulerna.
background_color_transparency	integer	Nej	0	Bakgrundens genomskinlighet, 0–100.
custom_eyes_color	boolean	Nej	false	Om true använder ögonen eyes_inner_color och eyes_outer_color.
eyes_inner_color	string	Nej	#000000	Inre ögats HEX-färg.
eyes_outer_color	string	Nej	#000000	Yttre ögats HEX-färg.
qr_code_logo	string	Nej	—	Logotypbild-URL eller uppladdad filnyckel.
qr_code_logo_size	number	Nej	25	Logotypstorlek som procent av QR, 5–40.
frame	string	Nej	—	Valfri ramnyckel från studion.
frame_text	string	Nej	—	Bildtext ritad på ramen.

Innehållsfält per typ

Namn	Typ	Obligatorisk	Standard	Beskrivning
phone	string	Nej	—	Telefonnummer när type är phone.
sms	string	Nej	—	Telefonnummer när type är sms.
sms_body	string	Nej	—	SMS-meddelandets brödtext.
email	string	Nej	—	Mottagare när type är email.
email_subject	string	Nej	—	E-postämne.
email_body	string	Nej	—	E-postbrödtext.
whatsapp	string	Nej	—	WhatsApp-nummer, endast siffror.
whatsapp_body	string	Nej	—	Förifylld WhatsApp-text.
wifi_ssid	string	Nej	—	Nätverksnamn när type är wifi.
wifi_password	string	Nej	—	Wi-Fi-lösenord.
wifi_encryption	string	Nej	WPA	nopass, WEP, WPA eller WPA/WPA2.
location_latitude	number	Nej	—	Latitud när type är location.
location_longitude	number	Nej	—	Longitud när type är location.
event	string	Nej	—	Evenemangstitel när type är event.
event_start_datetime	string	Nej	—	ISO-datumtid för evenemangets start.
vcard first_name / last_name / email	string	Nej	—	vCard-fält: first_name, last_name, email och övriga studionycklar.

Förfrågningsexempel

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

Fler exempel

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

Svarsexempel

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

Lista QR-kod

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

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

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

Läs en QR-kod

Namn	Typ	Obligatorisk	Beskrivning
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}

Uppdatera QR-kod

Namn	Typ	Obligatorisk	Standard	Beskrivning
id	integer	Ja	—	—
name	string	Nej	—	Etikett som sparas på resursen.
type	string	Nej	url	Innehållstyp. En av de stödda QR-nycklarna, utom file.
url	string	Nej	—	Mål-URL. Krävs när type är url.
text	string	Nej	—	Vanlig text. Krävs när type är text. För masstext, separera rader i det här fältet.
url_dynamic	boolean	Nej	false	Om true skapas en kort länk och QR-koden kodar den länken så att målet kan ändras senare.
project_id	integer	Nej	—	Projekt att koppla resursen till.
is_bulk	boolean	Nej	false	Om true och type är text skapas en QR per rad i text.
style	string	Nej	square	Modulform. Exempel: square, dot, rounded, heart, hexagon.
inner_eye_style	string	Nej	square	Inre sökarmönsterform. Exempel: square, dot, circle, rounded.
outer_eye_style	string	Nej	square	Yttre sökarmönsterform. Exempel: square, circle, rounded, flower.
size	integer	Nej	500	Bildstorlek i pixlar, 50–2000.
margin	integer	Nej	0	Tystzonsmoduler, 0–25.
ecc	string	Nej	M	Felkorrigering: L, M, Q eller H. Använd H när du lägger till en logotyp.
foreground_type	string	Nej	color	color eller gradient.
foreground_color	string	Nej	#000000	Modulfärg som HEX.
foreground_gradient_style	string	Nej	horizontal	vertical, horizontal, diagonal, inverse_diagonal eller radial.
foreground_gradient_one	string	Nej	—	Första gradient-HEX-färgen.
foreground_gradient_two	string	Nej	—	Andra gradient-HEX-färgen.
background_color	string	Nej	#ffffff	Bakgrunds-HEX-färg. Håll den ljusare än modulerna.
background_color_transparency	integer	Nej	0	Bakgrundens genomskinlighet, 0–100.
custom_eyes_color	boolean	Nej	false	Om true använder ögonen eyes_inner_color och eyes_outer_color.
eyes_inner_color	string	Nej	#000000	Inre ögats HEX-färg.
eyes_outer_color	string	Nej	#000000	Yttre ögats HEX-färg.
qr_code_logo	string	Nej	—	Logotypbild-URL eller uppladdad filnyckel.
qr_code_logo_size	number	Nej	25	Logotypstorlek som procent av QR, 5–40.
frame	string	Nej	—	Valfri ramnyckel från studion.
frame_text	string	Nej	—	Bildtext ritad på ramen.

Förfrågningsexempel

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}

Ta bort QR-kod

Namn	Typ	Obligatorisk	Beskrivning
id	integer	Ja	—

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

Parameternamn och JSON-exempel visas på engelska. Ersätt YOUR_API_KEY med din kontonyckel.