QR-koder

Opret QR-koder med logo, farver, stile og indholdstyper, og list eller opdater dem derefter.

Understøttede typer

Send type som en af disse nøgler. Indholdsfelter ændrer sig med typen.

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

POST/api/v1/qr-codes

Opret QR-kode

Send JSON i forespørgselsbrødteksten. name og type er påkrævet. For url-typer skal du sende url. Tilføj style, farver og qr_code_logo for at matche en designet kode fra studiet. file-typen findes ikke på API'et.

Navn	Type	Påkrævet	Standard	Beskrivelse
name	string	Ja	—	Etiket gemt på ressourcen.
type	string	Ja	url	Indholdstype. En af de understøttede QR-nøgler, undtagen file.
url	string	Nej	—	Destinations-URL. Påkrævet når type er url.
text	string	Nej	—	Almindelig tekst. Påkrævet når type er text. Til masse-tekst adskilles linjer i dette felt.
url_dynamic	boolean	Nej	false	Hvis true, oprettes et kort link, og QR-koden koder det link, så destinationen senere kan ændres.
project_id	integer	Nej	—	Projekt, ressourcen knyttes til.
is_bulk	boolean	Nej	false	Hvis true og type er text, oprettes én QR pr. linje i text.
style	string	Nej	square	Modulform. Eksempler: square, dot, rounded, heart, hexagon.
inner_eye_style	string	Nej	square	Indre finder-mønsterform. Eksempler: square, dot, circle, rounded.
outer_eye_style	string	Nej	square	Ydre finder-mønsterform. Eksempler: square, circle, rounded, flower.
size	integer	Nej	500	Billedstørrelse i pixels, 50–2000.
margin	integer	Nej	0	Quiet-zone-moduler, 0–25.
ecc	string	Nej	M	Fejlkorrektion: L, M, Q eller H. Brug H, når du tilføjer et logo.
foreground_type	string	Nej	color	color eller gradient.
foreground_color	string	Nej	#000000	Modulfarve som HEX.
foreground_gradient_style	string	Nej	horizontal	vertical, horizontal, diagonal, inverse_diagonal eller radial.
foreground_gradient_one	string	Nej	—	Første gradient-HEX-farve.
foreground_gradient_two	string	Nej	—	Anden gradient-HEX-farve.
background_color	string	Nej	#ffffff	Baggrunds-HEX-farve. Hold den lysere end modulerne.
background_color_transparency	integer	Nej	0	Baggrundens gennemsigtighed, 0–100.
custom_eyes_color	boolean	Nej	false	Hvis true, bruger øjnene eyes_inner_color og eyes_outer_color.
eyes_inner_color	string	Nej	#000000	Indre-øje HEX-farve.
eyes_outer_color	string	Nej	#000000	Ydre-øje HEX-farve.
qr_code_logo	string	Nej	—	Logo-billed-URL eller uploadet filnøgle.
qr_code_logo_size	number	Nej	25	Logostørrelse som procent af QR, 5–40.
frame	string	Nej	—	Valgfri rammenøgle fra studiet.
frame_text	string	Nej	—	Tekst tegnet på rammen.

Indholdsfelter efter type

Navn	Type	Påkrævet	Standard	Beskrivelse
phone	string	Nej	—	Telefonnummer når type er phone.
sms	string	Nej	—	Telefonnummer når type er sms.
sms_body	string	Nej	—	SMS-beskedtekst.
email	string	Nej	—	Modtager når type er email.
email_subject	string	Nej	—	E-mail-emne.
email_body	string	Nej	—	E-mail-brødtekst.
whatsapp	string	Nej	—	WhatsApp-nummer, kun cifre.
whatsapp_body	string	Nej	—	Forudfyldt WhatsApp-tekst.
wifi_ssid	string	Nej	—	Netværksnavn når type er wifi.
wifi_password	string	Nej	—	Wi-Fi-adgangskode.
wifi_encryption	string	Nej	WPA	nopass, WEP, WPA eller WPA/WPA2.
location_latitude	number	Nej	—	Breddegrad når type er location.
location_longitude	number	Nej	—	Længdegrad når type er location.
event	string	Nej	—	Begivenhedstitel når type er event.
event_start_datetime	string	Nej	—	ISO-datetime for begivenhedens start.
vcard first_name / last_name / email	string	Nej	—	vCard-felter: first_name, last_name, email og de øvrige studio-nøgler.

Forespørgselseksempel

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

Flere eksempler

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

Svareksempel

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

List QR-kode

Navn	Type	Påkrævet	Beskrivelse
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 én QR-kode

Navn	Type	Påkrævet	Beskrivelse
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}

Opdater QR-kode

Navn	Type	Påkrævet	Standard	Beskrivelse
id	integer	Ja	—	—
name	string	Nej	—	Etiket gemt på ressourcen.
type	string	Nej	url	Indholdstype. En af de understøttede QR-nøgler, undtagen file.
url	string	Nej	—	Destinations-URL. Påkrævet når type er url.
text	string	Nej	—	Almindelig tekst. Påkrævet når type er text. Til masse-tekst adskilles linjer i dette felt.
url_dynamic	boolean	Nej	false	Hvis true, oprettes et kort link, og QR-koden koder det link, så destinationen senere kan ændres.
project_id	integer	Nej	—	Projekt, ressourcen knyttes til.
is_bulk	boolean	Nej	false	Hvis true og type er text, oprettes én QR pr. linje i text.
style	string	Nej	square	Modulform. Eksempler: square, dot, rounded, heart, hexagon.
inner_eye_style	string	Nej	square	Indre finder-mønsterform. Eksempler: square, dot, circle, rounded.
outer_eye_style	string	Nej	square	Ydre finder-mønsterform. Eksempler: square, circle, rounded, flower.
size	integer	Nej	500	Billedstørrelse i pixels, 50–2000.
margin	integer	Nej	0	Quiet-zone-moduler, 0–25.
ecc	string	Nej	M	Fejlkorrektion: L, M, Q eller H. Brug H, når du tilføjer et logo.
foreground_type	string	Nej	color	color eller gradient.
foreground_color	string	Nej	#000000	Modulfarve som HEX.
foreground_gradient_style	string	Nej	horizontal	vertical, horizontal, diagonal, inverse_diagonal eller radial.
foreground_gradient_one	string	Nej	—	Første gradient-HEX-farve.
foreground_gradient_two	string	Nej	—	Anden gradient-HEX-farve.
background_color	string	Nej	#ffffff	Baggrunds-HEX-farve. Hold den lysere end modulerne.
background_color_transparency	integer	Nej	0	Baggrundens gennemsigtighed, 0–100.
custom_eyes_color	boolean	Nej	false	Hvis true, bruger øjnene eyes_inner_color og eyes_outer_color.
eyes_inner_color	string	Nej	#000000	Indre-øje HEX-farve.
eyes_outer_color	string	Nej	#000000	Ydre-øje HEX-farve.
qr_code_logo	string	Nej	—	Logo-billed-URL eller uploadet filnøgle.
qr_code_logo_size	number	Nej	25	Logostørrelse som procent af QR, 5–40.
frame	string	Nej	—	Valgfri rammenøgle fra studiet.
frame_text	string	Nej	—	Tekst tegnet på rammen.

Forespørgselseksempel

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}

Slet QR-kode

Navn	Type	Påkrævet	Beskrivelse
id	integer	Ja	—

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

Parameternavne og JSON-eksempler vises på engelsk. Erstat YOUR_API_KEY med din kontonøgle.