GetQR API-et er i beta og er tilgjengelig for utvalgte arbeidsområder. Detaljer kan endres før den generelle lanseringen.
Last opp en fil
1
Registrer filen
Kall Registrer en filopplasting med filens
target, contentType og size. target bestemmer hvilke innholdstyper som godtas, og størrelsesgrensen. Du får en fileId og en uploadUrl.2
Send filen
Send filen med en
PUT-forespørsel til uploadUrl. Content-Type og Content-Length må stemme nøyaktig med contentType og size du registrerte: alt annet avvises. URL-en er forhåndssignert, så ikke legg til API-nøkkelen din. Den utløper etter 10 minutter.3
Bruk fil-ID-en
Send
fileId når du oppretter en QR-kode:- Som
fileIdfor enpdf-,image- ellervideo-QR-kode. Last opp med tilsvarende target. - Som
fileIdfor profilbildet til envcard-,social-,multilink- ellerevent-QR-kode. Last opp med targetlogo. - Som
logoOptions.fileId, medlogoOptions.typesatt tiluploaded, for en egen logo. Last opp med targetlogo. Se Tilpasning.
Grenser
- Ren MIME-type. Send én type og undertype med små bokstaver, for eksempel
image/png. Parametere som;charset=og lister avvises. - Ingen SVG. XML-baserte typer som
image/svg+xmlgodtas ikke. Last opp et rasterbilde, for eksempelimage/pngellerimage/jpeg.
Headere
string
påkrevd
Bearer etterfulgt av API-nøkkelen din. Se Autentisering.string
påkrevd
application/json.Registrer en filopplasting
POST /api/v1/files
Registrerer en fil og returnerer en forhåndssignert URL som filen skal lastes opp til. Dette kallet laster ikke opp selve filen.
string
påkrevd
Hva filen skal brukes til:
pdf, image, video eller logo. Bestemmer hvilke innholdstyper som godtas, og størrelsesgrensen. Se Grenser.string
påkrevd
MIME-typen til filen, for eksempel
application/pdf, uten parametere. Opplastingsforespørselen må sende nøyaktig denne Content-Type.integer
påkrevd
Nøyaktig filstørrelse i byte, et positivt heltall. Kontrolleres mot grensen for target. Opplastingsforespørselen må sende nøyaktig denne
Content-Length.string
Opprinnelig filnavn, opptil 255 tegn. Beholdes for visning i dashbordet. En bane med
/ eller \ avvises.string
ID som skal sendes som
fileId eller logoOptions.fileId.string
Forhåndssignert URL som filen skal sendes til med
PUT.integer
Sekunder til
uploadUrl utløper: 600.string
HTTP-metode for opplastingen:
PUT.Vanlige problemer
422 "Content type … is not allowed for target"
422 "Content type … is not allowed for target"
Innholdstypen passer ikke til target. For eksempel godtar
pdf bare application/pdf. Se Grenser.422 "must be a single lowercase type/subtype"
422 "must be a single lowercase type/subtype"
Send innholdstypen med små bokstaver og uten parametere:
image/png, ikke Image/PNG eller image/png; charset=utf-8.422 "File is too large for target"
422 "File is too large for target"
Den oppgitte
size er over grensen for target. Komprimer filen før du registrerer den.Opplastingen til uploadUrl mislykkes
Opplastingen til uploadUrl mislykkes
URL-en utløper 10 minutter etter at du registrerte filen, og forespørselen må sende nøyaktig den registrerte
Content-Type og Content-Length. Registrer filen på nytt for å få en ny URL.422 "is registered but its content was never uploaded" når jeg oppretter en QR-kode
422 "is registered but its content was never uploaded" når jeg oppretter en QR-kode
Du registrerte filen, men
PUT til uploadUrl ble ikke fullført. Last opp filen, og opprett deretter QR-koden.422 "was uploaded to …" når jeg oppretter en QR-kode
422 "was uploaded to …" når jeg oppretter en QR-kode
Filen ble registrert med et annet target, for eksempel en
image-fil brukt til en pdf-QR-kode. Registrer en ny opplasting med tilsvarende target.404 "File … was not found" når jeg oppretter en QR-kode
404 "File … was not found" når jeg oppretter en QR-kode
fileId finnes ikke. Hent den fra svaret på Registrer en filopplasting.