L’API di GetQR è in beta ed è disponibile per alcuni workspace selezionati. I dettagli possono cambiare prima del rilascio generale.
Carica un file
1
Registra il file
Chiama Registra il caricamento di un file con
target, contentType e size del file. Il target determina i tipi di contenuto accettati e il limite di dimensione. Ricevi un fileId e un uploadUrl.2
Invia il file
Invia il file con una richiesta
PUT a uploadUrl. I suoi Content-Type e Content-Length devono corrispondere esattamente al contentType e alla size registrati: qualsiasi altro valore viene rifiutato. L’URL è prefirmato, quindi non aggiungere la chiave API. Scade dopo 10 minuti.3
Usa l'ID del file
Passa
fileId quando crei un QR code:- Come
fileIdper un QR codepdf,imageovideo. Caricalo con il target corrispondente. - Come
fileIdper l’immagine del profilo di un QR codevcard,social,multilinkoevent. Caricalo con il targetlogo. - Come
logoOptions.fileId, conlogoOptions.typeimpostato suuploaded, per un logo personalizzato. Caricalo con il targetlogo. Consulta Personalizzazione.
Limiti
- Tipo MIME semplice. Invia un solo tipo e sottotipo in minuscolo, come
image/png. Parametri come;charset=ed elenchi vengono rifiutati. - Niente SVG. I tipi basati su XML come
image/svg+xmlnon sono accettati. Carica un’immagine raster comeimage/pngoimage/jpeg.
Header
string
obbligatorio
Bearer seguito dalla tua chiave API. Consulta Autenticazione.string
obbligatorio
application/json.Registra il caricamento di un file
POST /api/v1/files
Registra un file e restituisce un URL prefirmato su cui caricarlo. Questa chiamata non carica il file.
string
obbligatorio
A cosa serve il file:
pdf, image, video o logo. Determina i tipi di contenuto accettati e il limite di dimensione. Consulta Limiti.string
obbligatorio
Tipo MIME del file, ad esempio
application/pdf, senza parametri. La richiesta di caricamento deve inviare esattamente questo Content-Type.integer
obbligatorio
Dimensione esatta del file in byte, un numero intero positivo. Viene confrontata con il limite del target. La richiesta di caricamento deve inviare esattamente questo
Content-Length.string
Nome originale del file, fino a 255 caratteri. Conservato per essere mostrato nella dashboard. Un percorso con
/ o \ viene rifiutato.string
ID da passare come
fileId o logoOptions.fileId.string
URL prefirmato a cui inviare il file con
PUT.integer
Secondi prima della scadenza di
uploadUrl: 600.string
Metodo HTTP per il caricamento:
PUT.Problemi comuni
422 "Content type … is not allowed for target"
422 "Content type … is not allowed for target"
Il tipo di contenuto non corrisponde al target. Ad esempio,
pdf accetta solo application/pdf. Consulta Limiti.422 "must be a single lowercase type/subtype"
422 "must be a single lowercase type/subtype"
Invia il tipo di contenuto in minuscolo e senza parametri:
image/png, non Image/PNG o image/png; charset=utf-8.422 "File is too large for target"
422 "File is too large for target"
La
size dichiarata supera il limite del target. Comprimi il file prima di registrarlo.Il caricamento su uploadUrl non riesce
Il caricamento su uploadUrl non riesce
L’URL scade 10 minuti dopo la registrazione del file, e la richiesta deve inviare esattamente i
Content-Type e Content-Length registrati. Registra di nuovo il file per ottenere un nuovo URL.422 "is registered but its content was never uploaded" durante la creazione di un QR code
422 "is registered but its content was never uploaded" durante la creazione di un QR code
Hai registrato il file ma la
PUT su uploadUrl non è stata completata. Carica il file, poi crea il QR code.422 "was uploaded to …" durante la creazione di un QR code
422 "was uploaded to …" durante la creazione di un QR code
Il file è stato registrato con un target diverso, ad esempio un file
image usato per un QR code pdf. Registra un nuovo caricamento con il target corrispondente.404 "File … was not found" durante la creazione di un QR code
404 "File … was not found" durante la creazione di un QR code
Il
fileId non esiste. Prendilo dalla risposta di Registra il caricamento di un file.