Siirry pääsisältöön
GetQR API on beetavaiheessa, ja se on käytettävissä valituissa työtiloissa. Yksityiskohdat voivat muuttua ennen yleistä julkaisua.
PDF-, Image- ja Video-QR-koodit osoittavat tiedostoon, ja myös oma logo on tiedosto. Lataus tehdään kahdessa vaiheessa: rekisteröi tiedosto saadaksesi URL-osoitteen ja lähetä sitten tiedoston sisältö kyseiseen osoitteeseen.

​
Lataa tiedosto

1

Rekisteröi tiedosto

Kutsu päätepistettä Rekisteröi tiedoston lataus ja anna tiedoston target, contentType ja size. target määrää hyväksytyt sisältötyypit ja kokorajan. Saat vastauksena fileId-tunnuksen ja uploadUrl-osoitteen.
2

Lähetä tiedosto

Lähetä tiedosto PUT-pyynnöllä osoitteeseen uploadUrl. Sen Content-Type- ja Content-Length-arvojen on vastattava täsmälleen rekisteröimiäsi arvoja contentType ja size: kaikki muu hylätään. URL on valmiiksi allekirjoitettu, joten älä lisää API-avaintasi. Se vanhenee 10 minuutin kuluttua.
3

Käytä tiedostotunnusta

Välitä fileId, kun luot QR-koodin:
  • Kenttänä fileId pdf-, image- tai video-QR-koodille. Lataa vastaavalla targetilla.
  • Kenttänä fileId vcard-, social-, multilink- tai event-QR-koodin profiilikuvalle. Lataa targetilla logo.
  • Kenttänä logoOptions.fileId, kun logoOptions.type on uploaded, omalle logolle. Lataa targetilla logo. Katso Mukauttaminen.

​
Rajat

  • Pelkkä MIME-tyyppi. Lähetä yksi pienin kirjaimin kirjoitettu tyyppi ja alatyyppi, kuten image/png. Parametrit, kuten ;charset=, ja luettelot hylätään.
  • Ei SVG:tä. XML-pohjaisia tyyppejä, kuten image/svg+xml, ei hyväksytä. Lataa rasterikuva, kuten image/png tai image/jpeg.

​
Otsakkeet

​
string
vaadittu
Bearer ja sen perässä API-avaimesi. Katso Todennus.
​
string
vaadittu
application/json.

​
Rekisteröi tiedoston lataus

POST /api/v1/files Rekisteröi tiedoston ja palauttaa valmiiksi allekirjoitetun URL-osoitteen, johon se ladataan. Tämä kutsu ei lataa itse tiedostoa.
​
string
vaadittu
Mihin tiedostoa käytetään: pdf, image, video tai logo. Määrää hyväksytyt sisältötyypit ja kokorajan. Katso Rajat.
​
string
vaadittu
Tiedoston MIME-tyyppi, esimerkiksi application/pdf, ilman parametreja. Latauspyynnön on lähetettävä täsmälleen tämä Content-Type.
​
integer
vaadittu
Tiedoston tarkka koko tavuina, positiivinen kokonaisluku. Tarkistetaan targetin rajaa vasten. Latauspyynnön on lähetettävä täsmälleen tämä Content-Length.
​
string
Tiedoston alkuperäinen nimi, enintään 255 merkkiä. Säilytetään näyttämistä varten hallintapaneelissa. Polku, jossa on / tai \, hylätään.
​
string
Tunnus, joka välitetään kentässä fileId tai logoOptions.fileId.
​
string
Valmiiksi allekirjoitettu URL, johon tiedosto lähetetään PUT-pyynnöllä.
​
integer
Sekunnit siihen, kun uploadUrl vanhenee: 600.
​
string
Latauksen HTTP-metodi: PUT.

​
Yleisiä ongelmia

Sisältötyyppi ei vastaa targetia. Esimerkiksi pdf hyväksyy vain tyypin application/pdf. Katso Rajat.
Lähetä sisältötyyppi pienin kirjaimin ja ilman parametreja: image/png, ei Image/PNG tai image/png; charset=utf-8.
Ilmoitettu size ylittää targetin rajan. Pakkaa tiedosto ennen kuin rekisteröit sen.
URL vanhenee 10 minuuttia tiedoston rekisteröinnin jälkeen, ja pyynnön on lähetettävä täsmälleen rekisteröidyt Content-Type ja Content-Length. Rekisteröi tiedosto uudelleen saadaksesi uuden URL-osoitteen.
Rekisteröit tiedoston, mutta PUT-pyyntö osoitteeseen uploadUrl ei valmistunut. Lataa tiedosto ja luo sitten QR-koodi.
Tiedosto rekisteröitiin eri targetilla, esimerkiksi image-tiedosto pdf-QR-koodissa. Rekisteröi uusi lataus vastaavalla targetilla.
fileId-tunnusta ei ole olemassa. Ota se päätepisteen Rekisteröi tiedoston lataus vastauksesta.

​
Mitä seuraavaksi

QR-koodit

QR-tyypit

Mukauttaminen

Virheet