De GetQR API is in bèta en beschikbaar voor geselecteerde workspaces. Details kunnen nog veranderen vóór de algemene release.
Een bestand uploaden
1
Registreer het bestand
Roep Een bestandsupload registreren aan met de
target, contentType en size van het bestand. De target bepaalt de toegestane contenttypes en de maximale grootte. Je krijgt een fileId en een uploadUrl terug.2
Verstuur het bestand
Stuur het bestand met een
PUT-verzoek naar uploadUrl. De Content-Type en Content-Length moeten precies overeenkomen met de contentType en size die je hebt geregistreerd: al het andere wordt geweigerd. De URL is vooraf ondertekend, dus voeg je API-sleutel niet toe. Hij verloopt na 10 minuten.3
Gebruik de bestands-ID
Geef
fileId mee wanneer je een QR-code maakt:- Als
fileIdvoor eenpdf-,image- ofvideo-QR-code. Upload met de bijbehorende target. - Als
fileIdvoor de profielafbeelding van eenvcard-,social-,multilink- ofevent-QR-code. Upload met de targetlogo. - Als
logoOptions.fileId, metlogoOptions.typeingesteld opuploaded, voor een eigen logo. Upload met de targetlogo. Zie Aanpassing.
Limieten
- Kaal MIME-type. Stuur één type en subtype in kleine letters, zoals
image/png. Parameters zoals;charset=en lijsten worden geweigerd. - Geen SVG. Op XML gebaseerde types zoals
image/svg+xmlworden niet geaccepteerd. Upload een rasterafbeelding zoalsimage/pngofimage/jpeg.
Headers
string
vereist
Bearer gevolgd door je API-sleutel. Zie Authenticatie.string
vereist
application/json.Een bestandsupload registreren
POST /api/v1/files
Registreert een bestand en geeft een vooraf ondertekende URL terug om het naartoe te uploaden. Deze aanroep uploadt het bestand zelf niet.
string
vereist
Waar het bestand voor is:
pdf, image, video of logo. Bepaalt de toegestane contenttypes en de maximale grootte. Zie Limieten.string
vereist
MIME-type van het bestand, bijvoorbeeld
application/pdf, zonder parameters. Het uploadverzoek moet precies deze Content-Type versturen.integer
vereist
Exacte grootte van het bestand in bytes, een positief geheel getal. Wordt gecontroleerd tegen de limiet voor de target. Het uploadverzoek moet precies deze
Content-Length versturen.string
Oorspronkelijke bestandsnaam, maximaal 255 tekens. Wordt bewaard voor weergave in het dashboard. Een pad met
/ of \ wordt geweigerd.string
ID die je meegeeft als
fileId of logoOptions.fileId.string
Vooraf ondertekende URL waarnaar je het bestand met
PUT verstuurt.integer
Seconden tot
uploadUrl verloopt: 600.string
HTTP-methode voor de upload:
PUT.Veelvoorkomende problemen
422 "Content type … is not allowed for target"
422 "Content type … is not allowed for target"
Het contenttype past niet bij de target. Zo accepteert
pdf alleen application/pdf. Zie Limieten.422 "must be a single lowercase type/subtype"
422 "must be a single lowercase type/subtype"
Stuur het contenttype in kleine letters en zonder parameters:
image/png, niet Image/PNG of image/png; charset=utf-8.422 "File is too large for target"
422 "File is too large for target"
De opgegeven
size ligt boven de limiet voor de target. Comprimeer het bestand voordat je het registreert.De upload naar uploadUrl mislukt
De upload naar uploadUrl mislukt
De URL verloopt 10 minuten nadat je het bestand hebt geregistreerd, en het verzoek moet precies de geregistreerde
Content-Type en Content-Length versturen. Registreer het bestand opnieuw voor een nieuwe URL.422 "is registered but its content was never uploaded" bij het maken van een QR-code
422 "is registered but its content was never uploaded" bij het maken van een QR-code
Je hebt het bestand geregistreerd, maar de
PUT naar uploadUrl is niet voltooid. Upload het bestand en maak daarna de QR-code.422 "was uploaded to …" bij het maken van een QR-code
422 "was uploaded to …" bij het maken van een QR-code
Het bestand is geregistreerd met een andere target, bijvoorbeeld een
image-bestand voor een pdf-QR-code. Registreer een nieuwe upload met de bijbehorende target.404 "File … was not found" bij het maken van een QR-code
404 "File … was not found" bij het maken van een QR-code
De
fileId bestaat niet. Neem hem over uit het antwoord van Een bestandsupload registreren.