QR-codes

Maak QR-codes met logo, kleuren, stijlen en inhoudstypes, en lijst of werk ze daarna bij.

Ondersteunde types

Geef type op als een van deze sleutels. Inhoudsvelden veranderen met het type.

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

POST/api/v1/qr-codes

Maak QR-code

Stuur JSON in de request body. name en type zijn verplicht. Voor url-types geeft u url mee. Voeg style, kleuren en qr_code_logo toe om een ontworpen code uit de studio te evenaren. Het type file is niet beschikbaar via de API.

Naam	Type	Vereist	Standaard	Beschrijving
name	string	Ja	—	Label dat op de resource wordt opgeslagen.
type	string	Ja	url	Inhoudstype. Een van de ondersteunde QR-sleutels, behalve file.
url	string	Nee	—	Bestemmings-URL. Vereist wanneer type url is.
text	string	Nee	—	Platte tekst. Vereist wanneer type text is. Voor bulktekst scheidt u regels in dit veld.
url_dynamic	boolean	Nee	false	Als true, wordt een korte link gemaakt en codeert de QR die link, zodat de bestemming later kan wijzigen.
project_id	integer	Nee	—	Project waaraan de resource wordt gekoppeld.
is_bulk	boolean	Nee	false	Als true en type text is, wordt per regel in text één QR gemaakt.
style	string	Nee	square	Modulevorm. Voorbeelden: square, dot, rounded, heart, hexagon.
inner_eye_style	string	Nee	square	Vorm van het binnenste zoekpatroon. Voorbeelden: square, dot, circle, rounded.
outer_eye_style	string	Nee	square	Vorm van het buitenste zoekpatroon. Voorbeelden: square, circle, rounded, flower.
size	integer	Nee	500	Afbeeldingsgrootte in pixels, 50–2000.
margin	integer	Nee	0	Quiet-zone-modules, 0–25.
ecc	string	Nee	M	Foutcorrectie: L, M, Q of H. Gebruik H wanneer u een logo toevoegt.
foreground_type	string	Nee	color	color of gradient.
foreground_color	string	Nee	#000000	Modulekleur als HEX.
foreground_gradient_style	string	Nee	horizontal	vertical, horizontal, diagonal, inverse_diagonal of radial.
foreground_gradient_one	string	Nee	—	Eerste verloop-HEX-kleur.
foreground_gradient_two	string	Nee	—	Tweede verloop-HEX-kleur.
background_color	string	Nee	#ffffff	Achtergrond-HEX-kleur. Houd die lichter dan de modules.
background_color_transparency	integer	Nee	0	Achtergrondtransparantie, 0–100.
custom_eyes_color	boolean	Nee	false	Als true, gebruiken de ogen eyes_inner_color en eyes_outer_color.
eyes_inner_color	string	Nee	#000000	HEX-kleur van het binnenste oog.
eyes_outer_color	string	Nee	#000000	HEX-kleur van het buitenste oog.
qr_code_logo	string	Nee	—	Logo-afbeeldings-URL of geüploade bestandssleutel.
qr_code_logo_size	number	Nee	25	Logogrootte als percentage van de QR, 5–40.
frame	string	Nee	—	Optionele kadersleutel uit de studio.
frame_text	string	Nee	—	Bijschrift op het kader.

Inhoudsvelden per type

Naam	Type	Vereist	Standaard	Beschrijving
phone	string	Nee	—	Telefoonnummer wanneer type phone is.
sms	string	Nee	—	Telefoonnummer wanneer type sms is.
sms_body	string	Nee	—	SMS-berichttekst.
email	string	Nee	—	Ontvanger wanneer type email is.
email_subject	string	Nee	—	E-mailonderwerp.
email_body	string	Nee	—	E-mailtekst.
whatsapp	string	Nee	—	WhatsApp-nummer, alleen cijfers.
whatsapp_body	string	Nee	—	Vooraf ingevulde WhatsApp-tekst.
wifi_ssid	string	Nee	—	Netwerknaam wanneer type wifi is.
wifi_password	string	Nee	—	Wi-Fi-wachtwoord.
wifi_encryption	string	Nee	WPA	nopass, WEP, WPA of WPA/WPA2.
location_latitude	number	Nee	—	Breedtegraad wanneer type location is.
location_longitude	number	Nee	—	Lengtegraad wanneer type location is.
event	string	Nee	—	Evenementtitel wanneer type event is.
event_start_datetime	string	Nee	—	ISO-datumtijd voor de start van het evenement.
vcard first_name / last_name / email	string	Nee	—	vCard-velden: first_name, last_name, email en de overige studiosleutels.

Voorbeeldverzoek

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

Meer voorbeelden

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

Antwoordvoorbeeld

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

Lijst QR-code

Naam	Type	Vereist	Beschrijving
page	integer	Nee	Page number (default 1)
results_per_page	integer	Nee	Items per page (default 25, max 100)
search	string	Nee	Search term
search_by	string	Nee	Column to search
order_by	string	Nee	Sort column
order_type	string	Nee	asc or desc
datetime_start	string	Nee	ISO datetime filter start
datetime_end	string	Nee	ISO datetime filter end
project_id	integer	Nee	—
type	string	Nee	—

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

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

Lees één QR-code

Naam	Type	Vereist	Beschrijving
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}

Werk QR-code bij

Naam	Type	Vereist	Standaard	Beschrijving
id	integer	Ja	—	—
name	string	Nee	—	Label dat op de resource wordt opgeslagen.
type	string	Nee	url	Inhoudstype. Een van de ondersteunde QR-sleutels, behalve file.
url	string	Nee	—	Bestemmings-URL. Vereist wanneer type url is.
text	string	Nee	—	Platte tekst. Vereist wanneer type text is. Voor bulktekst scheidt u regels in dit veld.
url_dynamic	boolean	Nee	false	Als true, wordt een korte link gemaakt en codeert de QR die link, zodat de bestemming later kan wijzigen.
project_id	integer	Nee	—	Project waaraan de resource wordt gekoppeld.
is_bulk	boolean	Nee	false	Als true en type text is, wordt per regel in text één QR gemaakt.
style	string	Nee	square	Modulevorm. Voorbeelden: square, dot, rounded, heart, hexagon.
inner_eye_style	string	Nee	square	Vorm van het binnenste zoekpatroon. Voorbeelden: square, dot, circle, rounded.
outer_eye_style	string	Nee	square	Vorm van het buitenste zoekpatroon. Voorbeelden: square, circle, rounded, flower.
size	integer	Nee	500	Afbeeldingsgrootte in pixels, 50–2000.
margin	integer	Nee	0	Quiet-zone-modules, 0–25.
ecc	string	Nee	M	Foutcorrectie: L, M, Q of H. Gebruik H wanneer u een logo toevoegt.
foreground_type	string	Nee	color	color of gradient.
foreground_color	string	Nee	#000000	Modulekleur als HEX.
foreground_gradient_style	string	Nee	horizontal	vertical, horizontal, diagonal, inverse_diagonal of radial.
foreground_gradient_one	string	Nee	—	Eerste verloop-HEX-kleur.
foreground_gradient_two	string	Nee	—	Tweede verloop-HEX-kleur.
background_color	string	Nee	#ffffff	Achtergrond-HEX-kleur. Houd die lichter dan de modules.
background_color_transparency	integer	Nee	0	Achtergrondtransparantie, 0–100.
custom_eyes_color	boolean	Nee	false	Als true, gebruiken de ogen eyes_inner_color en eyes_outer_color.
eyes_inner_color	string	Nee	#000000	HEX-kleur van het binnenste oog.
eyes_outer_color	string	Nee	#000000	HEX-kleur van het buitenste oog.
qr_code_logo	string	Nee	—	Logo-afbeeldings-URL of geüploade bestandssleutel.
qr_code_logo_size	number	Nee	25	Logogrootte als percentage van de QR, 5–40.
frame	string	Nee	—	Optionele kadersleutel uit de studio.
frame_text	string	Nee	—	Bijschrift op het kader.

Voorbeeldverzoek

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}

Verwijder QR-code

Naam	Type	Vereist	Beschrijving
id	integer	Ja	—

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

Parameternamen en JSON-voorbeelden worden in het Engels getoond. Vervang YOUR_API_KEY door uw accountsleutel.