Hoppa till huvudinnehåll
GetQR:s API är i beta och finns för utvalda arbetsytor. Detaljer kan ändras före den allmänna lanseringen.
QR-koder av typen PDF, Image och Video pekar på en fil, och en egen logotyp är också en fil. Uppladdningen sker i två steg: registrera filen för att få en URL och skicka sedan filens innehåll till den URL:en.

Ladda upp en fil

1

Registrera filen

Anropa Registrera en filuppladdning med filens target, contentType och size. target avgör vilka innehållstyper som accepteras och storleksgränsen. Du får ett fileId och en uploadUrl.
2

Skicka filen

Skicka filen med en PUT-begäran till uploadUrl. Dess Content-Type och Content-Length måste exakt matcha den contentType och size som du registrerade: allt annat avvisas. URL:en är försignerad, så lägg inte till din API-nyckel. Den går ut efter 10 minuter.
3

Använd fil-id:t

Skicka fileId när du skapar en QR-kod:
  • Som fileId för en QR-kod av typen pdf, image eller video. Ladda upp med matchande target.
  • Som fileId för profilbilden i en QR-kod av typen vcard, social, multilink eller event. Ladda upp med target logo.
  • Som logoOptions.fileId, med logoOptions.type satt till uploaded, för en egen logotyp. Ladda upp med target logo. Se Anpassning.

Gränser

  • Enkel MIME-typ. Skicka en enda typ och undertyp med gemener, som image/png. Parametrar som ;charset= och listor avvisas.
  • Ingen SVG. XML-baserade typer som image/svg+xml accepteras inte. Ladda upp en rasterbild som image/png eller image/jpeg.

Huvuden

string
obligatorisk
Bearer följt av din API-nyckel. Se Autentisering.
string
obligatorisk
application/json.

Registrera en filuppladdning

POST /api/v1/files Registrerar en fil och returnerar en försignerad URL att ladda upp den till. Det här anropet laddar inte upp själva filen.
string
obligatorisk
Vad filen ska användas till: pdf, image, video eller logo. Avgör vilka innehållstyper som accepteras och storleksgränsen. Se Gränser.
string
obligatorisk
Filens MIME-typ, till exempel application/pdf, utan parametrar. Uppladdningsbegäran måste skicka exakt den här Content-Type.
integer
obligatorisk
Filens exakta storlek i byte, ett positivt heltal. Kontrolleras mot gränsen för target. Uppladdningsbegäran måste skicka exakt den här Content-Length.
string
Ursprungligt filnamn, högst 255 tecken. Sparas för visning i instrumentpanelen. En sökväg med / eller \ avvisas.
string
Id att skicka som fileId eller logoOptions.fileId.
string
Försignerad URL som filen skickas till med PUT.
integer
Sekunder tills uploadUrl går ut: 600.
string
HTTP-metod för uppladdningen: PUT.

Vanliga problem

Innehållstypen matchar inte target. Till exempel accepterar pdf bara application/pdf. Se Gränser.
Skicka innehållstypen med gemener och utan parametrar: image/png, inte Image/PNG eller image/png; charset=utf-8.
Den angivna size överskrider gränsen för target. Komprimera filen innan du registrerar den.
URL:en går ut 10 minuter efter att du registrerat filen, och begäran måste skicka exakt den registrerade Content-Type och Content-Length. Registrera filen igen för att få en ny URL.
Du registrerade filen men PUT till uploadUrl slutfördes inte. Ladda upp filen och skapa sedan QR-koden.
Filen registrerades med en annan target, till exempel en image-fil som används för en pdf-QR-kod. Registrera en ny uppladdning med matchande target.
fileId finns inte. Hämta det från svaret på Registrera en filuppladdning.

Nästa steg

QR-koder

QR-typer

Anpassning

Fel