QR codes

Créez des QR codes avec logo, couleurs, styles et types de contenu, puis listez-les ou mettez-les à jour.

Types pris en charge

Passez type parmi ces clés. Les champs de contenu changent selon le type.

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

POST/api/v1/qr-codes

Créer QR code

Envoyez du JSON dans le corps de la requête. name et type sont requis. Pour les types url, passez url. Ajoutez style, les couleurs et qr_code_logo pour reproduire un code conçu dans le studio. Le type file n'est pas disponible via l'API.

Nom	Type	Requis	Par défaut	Description
name	string	Oui	—	Libellé enregistré sur la ressource.
type	string	Oui	url	Type de contenu. Une des clés QR prises en charge, sauf file.
url	string	Non	—	URL de destination. Requis lorsque type est url.
text	string	Non	—	Texte brut. Requis lorsque type est text. Pour du texte en masse, séparez les lignes dans ce champ.
url_dynamic	boolean	Non	false	Si true, un lien court est créé et le QR encode ce lien afin de pouvoir changer la destination plus tard.
project_id	integer	Non	—	Projet auquel rattacher la ressource.
is_bulk	boolean	Non	false	Si true et type est text, un QR est créé par ligne dans text.
style	string	Non	square	Forme du module. Exemples : square, dot, rounded, heart, hexagon.
inner_eye_style	string	Non	square	Forme du motif de recherche intérieur. Exemples : square, dot, circle, rounded.
outer_eye_style	string	Non	square	Forme du motif de recherche extérieur. Exemples : square, circle, rounded, flower.
size	integer	Non	500	Taille de l'image en pixels, 50–2000.
margin	integer	Non	0	Modules de zone de silence, 0–25.
ecc	string	Non	M	Correction d'erreurs : L, M, Q ou H. Utilisez H lorsque vous ajoutez un logo.
foreground_type	string	Non	color	color ou gradient.
foreground_color	string	Non	#000000	Couleur des modules en HEX.
foreground_gradient_style	string	Non	horizontal	vertical, horizontal, diagonal, inverse_diagonal ou radial.
foreground_gradient_one	string	Non	—	Première couleur HEX du dégradé.
foreground_gradient_two	string	Non	—	Deuxième couleur HEX du dégradé.
background_color	string	Non	#ffffff	Couleur HEX de fond. Gardez-la plus claire que les modules.
background_color_transparency	integer	Non	0	Transparence du fond, 0–100.
custom_eyes_color	boolean	Non	false	Si true, les yeux utilisent eyes_inner_color et eyes_outer_color.
eyes_inner_color	string	Non	#000000	Couleur HEX de l'œil intérieur.
eyes_outer_color	string	Non	#000000	Couleur HEX de l'œil extérieur.
qr_code_logo	string	Non	—	URL de l'image du logo ou clé du fichier téléversé.
qr_code_logo_size	number	Non	25	Taille du logo en pourcentage du QR, 5–40.
frame	string	Non	—	Clé de cadre optionnelle du studio.
frame_text	string	Non	—	Légende dessinée sur le cadre.

Champs de contenu par type

Nom	Type	Requis	Par défaut	Description
phone	string	Non	—	Numéro de téléphone lorsque type est phone.
sms	string	Non	—	Numéro de téléphone lorsque type est sms.
sms_body	string	Non	—	Corps du message SMS.
email	string	Non	—	Destinataire lorsque type est email.
email_subject	string	Non	—	Objet de l'e-mail.
email_body	string	Non	—	Corps de l'e-mail.
whatsapp	string	Non	—	Numéro WhatsApp, chiffres uniquement.
whatsapp_body	string	Non	—	Texte WhatsApp prérempli.
wifi_ssid	string	Non	—	Nom du réseau lorsque type est wifi.
wifi_password	string	Non	—	Mot de passe Wi-Fi.
wifi_encryption	string	Non	WPA	nopass, WEP, WPA ou WPA/WPA2.
location_latitude	number	Non	—	Latitude lorsque type est location.
location_longitude	number	Non	—	Longitude lorsque type est location.
event	string	Non	—	Titre de l'événement lorsque type est event.
event_start_datetime	string	Non	—	Date-heure ISO du début de l'événement.
vcard first_name / last_name / email	string	Non	—	Champs vCard : first_name, last_name, email et les autres clés du studio.

Exemple de requête

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

Plus d'exemples

QR en dégradé

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

QR Wi-Fi

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

Exemple de réponse

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

Lister QR code

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

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

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

Lire un QR code

Nom	Type	Requis	Description
id	integer	Oui	—

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

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

Mettre à jour QR code

Nom	Type	Requis	Par défaut	Description
id	integer	Oui	—	—
name	string	Non	—	Libellé enregistré sur la ressource.
type	string	Non	url	Type de contenu. Une des clés QR prises en charge, sauf file.
url	string	Non	—	URL de destination. Requis lorsque type est url.
text	string	Non	—	Texte brut. Requis lorsque type est text. Pour du texte en masse, séparez les lignes dans ce champ.
url_dynamic	boolean	Non	false	Si true, un lien court est créé et le QR encode ce lien afin de pouvoir changer la destination plus tard.
project_id	integer	Non	—	Projet auquel rattacher la ressource.
is_bulk	boolean	Non	false	Si true et type est text, un QR est créé par ligne dans text.
style	string	Non	square	Forme du module. Exemples : square, dot, rounded, heart, hexagon.
inner_eye_style	string	Non	square	Forme du motif de recherche intérieur. Exemples : square, dot, circle, rounded.
outer_eye_style	string	Non	square	Forme du motif de recherche extérieur. Exemples : square, circle, rounded, flower.
size	integer	Non	500	Taille de l'image en pixels, 50–2000.
margin	integer	Non	0	Modules de zone de silence, 0–25.
ecc	string	Non	M	Correction d'erreurs : L, M, Q ou H. Utilisez H lorsque vous ajoutez un logo.
foreground_type	string	Non	color	color ou gradient.
foreground_color	string	Non	#000000	Couleur des modules en HEX.
foreground_gradient_style	string	Non	horizontal	vertical, horizontal, diagonal, inverse_diagonal ou radial.
foreground_gradient_one	string	Non	—	Première couleur HEX du dégradé.
foreground_gradient_two	string	Non	—	Deuxième couleur HEX du dégradé.
background_color	string	Non	#ffffff	Couleur HEX de fond. Gardez-la plus claire que les modules.
background_color_transparency	integer	Non	0	Transparence du fond, 0–100.
custom_eyes_color	boolean	Non	false	Si true, les yeux utilisent eyes_inner_color et eyes_outer_color.
eyes_inner_color	string	Non	#000000	Couleur HEX de l'œil intérieur.
eyes_outer_color	string	Non	#000000	Couleur HEX de l'œil extérieur.
qr_code_logo	string	Non	—	URL de l'image du logo ou clé du fichier téléversé.
qr_code_logo_size	number	Non	25	Taille du logo en pourcentage du QR, 5–40.
frame	string	Non	—	Clé de cadre optionnelle du studio.
frame_text	string	Non	—	Légende dessinée sur le cadre.

Exemple de requête

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}

Supprimer QR code

Nom	Type	Requis	Description
id	integer	Oui	—

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

Noms de paramètres et exemples JSON en anglais. Remplacez YOUR_API_KEY par votre clé.