Codici QR

Crea codici QR con logo, colori, stili e tipi di contenuto, poi elenca o aggiornali.

Tipi supportati

Passa type come una di queste chiavi. I campi contenuto cambiano con il tipo.

  • text
  • url
  • phone
  • sms
  • email
  • whatsapp
  • facetime
  • location
  • wifi
  • event
  • vcard
  • crypto
  • paypal
  • upi
  • epc
  • pix
POST/api/v1/qr-codes
Crea codice QR

Invia JSON nel corpo della richiesta. name e type sono obbligatori. Per i tipi url, passa url. Aggiungi style, colori e qr_code_logo per replicare un codice progettato nello studio. Il tipo file non è disponibile tramite API.

NomeTipoObbligatorioPredefinitoDescrizione
namestringEtichetta salvata sulla risorsa.
typestringurlTipo di contenuto. Una delle chiavi QR supportate, tranne file.
urlstringNoURL di destinazione. Obbligatorio quando type è url.
textstringNoTesto semplice. Obbligatorio quando type è text. Per testo in blocco, separa le righe in questo campo.
url_dynamicbooleanNofalseSe true, viene creato un link breve e il QR lo codifica così la destinazione può cambiare in seguito.
project_idintegerNoProgetto a cui collegare la risorsa.
is_bulkbooleanNofalseSe true e type è text, viene creato un QR per ogni riga in text.
stylestringNosquareForma del modulo. Esempi: square, dot, rounded, heart, hexagon.
inner_eye_stylestringNosquareForma del pattern di ricerca interno. Esempi: square, dot, circle, rounded.
outer_eye_stylestringNosquareForma del pattern di ricerca esterno. Esempi: square, circle, rounded, flower.
sizeintegerNo500Dimensione dell'immagine in pixel, 50–2000.
marginintegerNo0Moduli della zona di quiete, 0–25.
eccstringNoMCorrezione errori: L, M, Q o H. Usa H quando aggiungi un logo.
foreground_typestringNocolorcolor o gradient.
foreground_colorstringNo#000000Colore dei moduli in HEX.
foreground_gradient_stylestringNohorizontalvertical, horizontal, diagonal, inverse_diagonal o radial.
foreground_gradient_onestringNoPrimo colore HEX del gradiente.
foreground_gradient_twostringNoSecondo colore HEX del gradiente.
background_colorstringNo#ffffffColore HEX di sfondo. Tienilo più chiaro dei moduli.
background_color_transparencyintegerNo0Trasparenza dello sfondo, 0–100.
custom_eyes_colorbooleanNofalseSe true, gli occhi usano eyes_inner_color e eyes_outer_color.
eyes_inner_colorstringNo#000000Colore HEX dell'occhio interno.
eyes_outer_colorstringNo#000000Colore HEX dell'occhio esterno.
qr_code_logostringNoURL dell'immagine del logo o chiave del file caricato.
qr_code_logo_sizenumberNo25Dimensione del logo in percentuale del QR, 5–40.
framestringNoChiave cornice opzionale dallo studio.
frame_textstringNoDidascalia disegnata sulla cornice.

Campi contenuto per tipo

NomeTipoObbligatorioPredefinitoDescrizione
phonestringNoNumero di telefono quando type è phone.
smsstringNoNumero di telefono quando type è sms.
sms_bodystringNoCorpo del messaggio SMS.
emailstringNoDestinatario quando type è email.
email_subjectstringNoOggetto dell'email.
email_bodystringNoCorpo dell'email.
whatsappstringNoNumero WhatsApp, solo cifre.
whatsapp_bodystringNoTesto WhatsApp precompilato.
wifi_ssidstringNoNome della rete quando type è wifi.
wifi_passwordstringNoPassword Wi-Fi.
wifi_encryptionstringNoWPAnopass, WEP, WPA o WPA/WPA2.
location_latitudenumberNoLatitudine quando type è location.
location_longitudenumberNoLongitudine quando type è location.
eventstringNoTitolo dell'evento quando type è event.
event_start_datetimestringNoData-ora ISO dell'inizio evento.
vcard first_name / last_name / emailstringNoCampi vCard: first_name, last_name, email e le altre chiavi dello studio.

Esempio di richiesta

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

Altri esempi

QR a gradiente

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

Esempio di risposta

{
  "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
Elenca codice QR
NomeTipoObbligatorioDescrizione
pageintegerNoPage number (default 1)
results_per_pageintegerNoItems per page (default 25, max 100)
searchstringNoSearch term
search_bystringNoColumn to search
order_bystringNoSort column
order_typestringNoasc or desc
datetime_startstringNoISO datetime filter start
datetime_endstringNoISO datetime filter end
project_idintegerNo
typestringNo
curl -X GET 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY'
GET/api/v1/qr-codes/{id}
Leggi un codice QR
NomeTipoObbligatorioDescrizione
idinteger
curl -X GET 'https://forqrcode.com/api/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'
PATCH/api/v1/qr-codes/{id}
Aggiorna codice QR
NomeTipoObbligatorioPredefinitoDescrizione
idinteger
namestringNoEtichetta salvata sulla risorsa.
typestringNourlTipo di contenuto. Una delle chiavi QR supportate, tranne file.
urlstringNoURL di destinazione. Obbligatorio quando type è url.
textstringNoTesto semplice. Obbligatorio quando type è text. Per testo in blocco, separa le righe in questo campo.
url_dynamicbooleanNofalseSe true, viene creato un link breve e il QR lo codifica così la destinazione può cambiare in seguito.
project_idintegerNoProgetto a cui collegare la risorsa.
is_bulkbooleanNofalseSe true e type è text, viene creato un QR per ogni riga in text.
stylestringNosquareForma del modulo. Esempi: square, dot, rounded, heart, hexagon.
inner_eye_stylestringNosquareForma del pattern di ricerca interno. Esempi: square, dot, circle, rounded.
outer_eye_stylestringNosquareForma del pattern di ricerca esterno. Esempi: square, circle, rounded, flower.
sizeintegerNo500Dimensione dell'immagine in pixel, 50–2000.
marginintegerNo0Moduli della zona di quiete, 0–25.
eccstringNoMCorrezione errori: L, M, Q o H. Usa H quando aggiungi un logo.
foreground_typestringNocolorcolor o gradient.
foreground_colorstringNo#000000Colore dei moduli in HEX.
foreground_gradient_stylestringNohorizontalvertical, horizontal, diagonal, inverse_diagonal o radial.
foreground_gradient_onestringNoPrimo colore HEX del gradiente.
foreground_gradient_twostringNoSecondo colore HEX del gradiente.
background_colorstringNo#ffffffColore HEX di sfondo. Tienilo più chiaro dei moduli.
background_color_transparencyintegerNo0Trasparenza dello sfondo, 0–100.
custom_eyes_colorbooleanNofalseSe true, gli occhi usano eyes_inner_color e eyes_outer_color.
eyes_inner_colorstringNo#000000Colore HEX dell'occhio interno.
eyes_outer_colorstringNo#000000Colore HEX dell'occhio esterno.
qr_code_logostringNoURL dell'immagine del logo o chiave del file caricato.
qr_code_logo_sizenumberNo25Dimensione del logo in percentuale del QR, 5–40.
framestringNoChiave cornice opzionale dallo studio.
frame_textstringNoDidascalia disegnata sulla cornice.

Esempio di richiesta

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}
Elimina codice QR
NomeTipoObbligatorioDescrizione
idinteger
curl -X DELETE 'https://forqrcode.com/api/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Nomi dei parametri ed esempi JSON sono in inglese. Sostituisci YOUR_API_KEY con la chiave del tuo account.