API-ul GetQR este în versiune beta și este disponibil pentru anumite spații de lucru. Detaliile se pot schimba înainte de lansarea generală.
Încărcarea unui fișier
1
Înregistrați fișierul
Apelați Înregistrarea unei încărcări de fișier cu
target, contentType și size ale fișierului. target stabilește tipurile de conținut acceptate și limita de dimensiune. Primiți un fileId și un uploadUrl.2
Trimiteți fișierul
Trimiteți fișierul cu o cerere
PUT la uploadUrl. Content-Type și Content-Length trebuie să corespundă exact cu contentType și size înregistrate: orice altceva este respins. URL-ul este presemnat, așa că nu adăugați cheia API. Expiră după 10 minute.3
Folosiți ID-ul fișierului
Transmiteți
fileId când creați un cod QR:- Ca
fileIdpentru un cod QRpdf,imagesauvideo. Încărcați cu targetul corespunzător. - Ca
fileIdpentru imaginea de profil a unui cod QRvcard,social,multilinksauevent. Încărcați cu targetullogo. - Ca
logoOptions.fileId, culogoOptions.typesetat lauploaded, pentru un logo personalizat. Încărcați cu targetullogo. Consultați Personalizare.
Limite
- Tip MIME simplu. Trimiteți un singur tip și subtip, cu litere mici, cum ar fi
image/png. Parametrii precum;charset=și listele sunt respinse. - Fără SVG. Tipurile bazate pe XML, cum ar fi
image/svg+xml, nu sunt acceptate. Încărcați o imagine raster, cum ar fiimage/pngsauimage/jpeg.
Anteturi
string
obligatoriu
Bearer urmat de cheia dvs. API. Consultați Autentificare.string
obligatoriu
application/json.Înregistrarea unei încărcări de fișier
POST /api/v1/files
Înregistrează un fișier și returnează un URL presemnat la care să îl încărcați. Acest apel nu încarcă fișierul propriu-zis.
string
obligatoriu
Pentru ce este fișierul:
pdf, image, video sau logo. Stabilește tipurile de conținut acceptate și limita de dimensiune. Consultați Limite.string
obligatoriu
Tipul MIME al fișierului, de exemplu
application/pdf, fără parametri. Cererea de încărcare trebuie să trimită exact acest Content-Type.integer
obligatoriu
Dimensiunea exactă a fișierului în octeți, un număr întreg pozitiv. Este verificată în raport cu limita targetului. Cererea de încărcare trebuie să trimită exact acest
Content-Length.string
Numele original al fișierului, până la 255 de caractere. Păstrat pentru afișare în panou. O cale cu
/ sau \ este respinsă.string
ID-ul de transmis ca
fileId sau logoOptions.fileId.string
URL-ul presemnat la care trimiteți fișierul cu
PUT.integer
Secundele până la expirarea
uploadUrl: 600.string
Metoda HTTP pentru încărcare:
PUT.Probleme frecvente
422 "Content type … is not allowed for target"
422 "Content type … is not allowed for target"
Tipul de conținut nu corespunde targetului. De exemplu,
pdf acceptă doar application/pdf. Consultați Limite.422 "must be a single lowercase type/subtype"
422 "must be a single lowercase type/subtype"
Trimiteți tipul de conținut cu litere mici și fără parametri:
image/png, nu Image/PNG sau image/png; charset=utf-8.422 "File is too large for target"
422 "File is too large for target"
size declarat depășește limita targetului. Comprimați fișierul înainte de a-l înregistra.Încărcarea la uploadUrl eșuează
Încărcarea la uploadUrl eșuează
URL-ul expiră la 10 minute după înregistrarea fișierului, iar cererea trebuie să trimită exact
Content-Type și Content-Length înregistrate. Înregistrați din nou fișierul pentru a obține un URL nou.422 "is registered but its content was never uploaded" la crearea unui cod QR
422 "is registered but its content was never uploaded" la crearea unui cod QR
Ați înregistrat fișierul, dar
PUT la uploadUrl nu s-a finalizat. Încărcați fișierul, apoi creați codul QR.422 "was uploaded to …" la crearea unui cod QR
422 "was uploaded to …" la crearea unui cod QR
Fișierul a fost înregistrat cu alt target, de exemplu un fișier
image folosit pentru un cod QR pdf. Înregistrați o încărcare nouă cu targetul corespunzător.404 "File … was not found" la crearea unui cod QR
404 "File … was not found" la crearea unui cod QR
fileId nu există. Preluați-l din răspunsul de la Înregistrarea unei încărcări de fișier.