Introduzione all'API

​

Cosa puoi fare

​

Guide

​

URL di base

https://getqr.com/api/v1

​

Versioni

• Le modifiche incompatibili escono con un nuovo prefisso di versione, ad esempio /api/v2/, e /api/v1/ continua a funzionare.
• Le aggiunte compatibili, come nuovi campi facoltativi o nuovi endpoint, possono comparire all’interno di v1. Ignora i campi della risposta che il tuo codice non riconosce.

​

Guida rapida

curl https://getqr.com/api/v1/health

curl -X POST "https://getqr.com/api/v1/qrs" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: first-qr-0001" \
  -d '{
    "qrType": "website",
    "data": "https://example.com",
    "title": "Landing page"
  }'

curl "https://getqr.com/api/v1/qrs/{qrId}/download?format=png&resolution=1024" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  --output qr-code.png

​

Richieste e risposte

• Formato. Invia il corpo delle richieste in JSON con Content-Type: application/json. Fa eccezione il caricamento CSV per la creazione in blocco, che usa multipart/form-data.
• Risposte. Le risposte sono in JSON. I download, come le immagini dei QR e gli archivi ZIP delle creazioni in blocco, restituiscono direttamente il file.
• Date. Le date sono stringhe ISO 8601 in UTC, ad esempio 2026-08-01T10:00:00.000Z.
• Parametri di query. I parametri booleani accettano le stringhe true o false.
• Aggiornamenti parziali. Gli endpoint PATCH modificano solo i campi che invii.
• Dati riservati. Le risposte non includono mai password o identificativi interni. Un QR code protetto da password indica solo passwordProtected: true.
• Workspace. Ogni richiesta viene eseguita nel workspace a cui appartiene la tua chiave API. Non devi indicare l’ID del workspace. Consulta Accesso e ruoli.
• Errori. Le richieste non riuscite restituiscono un oggetto error con un code stabile. Consulta Errori.

​

Paginazione

{
  "data": [ … ],
  "pagination": { "page": 1, "pageSize": 50, "total": 128, "hasMore": true }
}

​

Idempotenza

-H "Idempotency-Key: order-4821-qr"

• Se ripeti la richiesta con la stessa chiave entro 24 ore, ricevi la risposta originale invece di creare un secondo QR code.
• L’header di risposta x-idempotent-replay vale true per una risposta riproposta e false per una nuova.
• Se la prima richiesta con quella chiave è ancora in corso, l’API risponde 409 conflict. Riprova quando è terminata.
• Se riusi una chiave con un corpo della richiesta diverso, l’API risponde 422 unprocessable_entity.
• Senza l’header, un corpo della richiesta identico inviato entro 30 secondi viene considerato un duplicato.

​

Limiti di frequenza

​

In arrivo

​

Passaggi successivi