A GetQR API béta állapotban van, és csak kiválasztott munkaterületek számára érhető el. A részletek az általános kiadásig változhatnak.
Fájl feltöltése
1
Regisztrálja a fájlt
Hívja a Fájlfeltöltés regisztrálása végpontot a fájl
target, contentType és size értékével. A target határozza meg az elfogadott tartalomtípusokat és a méretkorlátot. Egy fileId és egy uploadUrl értéket kap vissza.2
Küldje el a fájlt
Küldje el a fájlt egy
PUT kéréssel az uploadUrl címre. A Content-Type és a Content-Length értékének pontosan meg kell egyeznie a regisztrált contentType és size értékkel: minden mást a rendszer elutasít. Az URL előre aláírt, ezért ne adja hozzá az API-kulcsát. 10 perc után lejár.3
Használja a fájlazonosítót
Adja meg a
fileId értékét, amikor QR-kódot hoz létre:fileIdmezőként egypdf,imagevagyvideoQR-kódhoz. A megfelelő céllal töltse fel.fileIdmezőként egyvcard,social,multilinkvagyeventQR-kód profilképéhez.logocéllal töltse fel.logoOptions.fileIdmezőként,uploadedértékre állítottlogoOptions.typemellett, egyéni logóhoz.logocéllal töltse fel. Lásd: Testreszabás.
Korlátok
- Csupasz MIME-típus. Egyetlen, kisbetűs típust és altípust küldjön, például
image/png. A paramétereket, például a;charset=részt, és a listákat a rendszer elutasítja. - Nincs SVG. Az XML-alapú típusok, például az
image/svg+xml, nem elfogadottak. Raszteres képet töltsön fel, példáulimage/pngvagyimage/jpegformátumban.
Fejlécek
string
kötelező
Bearer, majd az API-kulcsa. Lásd: Hitelesítés.string
kötelező
application/json.Fájlfeltöltés regisztrálása
POST /api/v1/files
Regisztrál egy fájlt, és visszaad egy előre aláírt URL-t, amelyre feltöltheti. Ez a hívás magát a fájlt nem tölti fel.
string
kötelező
Mire szolgál a fájl:
pdf, image, video vagy logo. Meghatározza az elfogadott tartalomtípusokat és a méretkorlátot. Lásd: Korlátok.string
kötelező
A fájl MIME-típusa paraméterek nélkül, például
application/pdf. A feltöltési kérésnek pontosan ezt a Content-Type értéket kell küldenie.integer
kötelező
A fájl pontos mérete bájtban, pozitív egész szám. A rendszer a célhoz tartozó korláttal veti össze. A feltöltési kérésnek pontosan ezt a
Content-Length értéket kell küldenie.string
Az eredeti fájlnév, legfeljebb 255 karakter. Az irányítópulton való megjelenítéshez tárolódik. A
/ vagy \ karaktert tartalmazó útvonalat a rendszer elutasítja.string
Azonosító, amelyet
fileId vagy logoOptions.fileId értékként adhat át.string
Előre aláírt URL, amelyre a fájlt
PUT kéréssel feltöltheti.integer
Másodpercek az
uploadUrl lejáratáig: 600.string
A feltöltés HTTP-metódusa:
PUT.Gyakori problémák
422 "Content type … is not allowed for target"
422 "Content type … is not allowed for target"
A tartalomtípus nem felel meg a célnak. Például a
pdf csak az application/pdf típust fogadja el. Lásd: Korlátok.422 "must be a single lowercase type/subtype"
422 "must be a single lowercase type/subtype"
A tartalomtípust kisbetűvel és paraméterek nélkül küldje:
image/png, ne Image/PNG vagy image/png; charset=utf-8.422 "File is too large for target"
422 "File is too large for target"
A megadott
size meghaladja a célhoz tartozó korlátot. Regisztrálás előtt tömörítse a fájlt.Az uploadUrl címre történő feltöltés sikertelen
Az uploadUrl címre történő feltöltés sikertelen
Az URL a fájl regisztrálása után 10 perccel lejár, és a kérésnek pontosan a regisztrált
Content-Type és Content-Length értéket kell küldenie. Regisztrálja újra a fájlt, hogy új URL-t kapjon.422 „is registered but its content was never uploaded” QR-kód létrehozásakor
422 „is registered but its content was never uploaded” QR-kód létrehozásakor
Regisztrálta a fájlt, de az
uploadUrl címre küldött PUT kérés nem fejeződött be. Töltse fel a fájlt, majd hozza létre a QR-kódot.422 „was uploaded to …” QR-kód létrehozásakor
422 „was uploaded to …” QR-kód létrehozásakor
A fájlt más céllal regisztrálták, például egy
image fájlt használ egy pdf QR-kódhoz. Regisztráljon új feltöltést a megfelelő céllal.404 „File … was not found” QR-kód létrehozásakor
404 „File … was not found” QR-kód létrehozásakor
A
fileId nem létezik. Vegye a Fájlfeltöltés regisztrálása válaszából.