GetQR API on beetavaiheessa, ja se on käytettävissä valituissa työtiloissa. Yksityiskohdat voivat muuttua ennen yleistä julkaisua.
QR-koodien data tyypeittäin
Kunkin 16 tyypin
data-muoto.Mukauttaminen
Pisteiden tyylit, värit, kehykset ja logot.
Käyttösäännöt
Aikataulu, skannausraja ja salasana.
QR-koodiobjekti
Jokainen QR-koodien päätepiste vastaa tällä objektilla, paitsi Poista ja Lataa. Listaus palauttaa taulukon näitä objekteja.string
QR-koodin yksilöllinen tunnus, esimerkiksi
qr_1EPcVfeHZAY2iNoVLsgW2Aqf.string
QR-koodin tyyppi, esimerkiksi
website. Kaikki 16 arvoa ovat kohdassa QR-koodien data tyypeittäin.string | null
QR-koodin nimi, joka näkyy hallintapaneelissa.
string | null
Vapaamuotoinen muistiinpano QR-koodista.
string
Tallennettu kuorma. Tyypeillä
wifi, vcard, social, multilink, event ja sms se on lähettämäsi kuorma. Kaikilla muilla tyypeillä se on lyhytlinkki, joten lue kohde kentästä url.boolean
true, kun QR-koodi on keskeytetty.boolean
true hallintapaneelissa tehdylle staattiselle QR-koodille, jolla ei ole lyhytlinkkiä. API luo aina dynaamisia QR-koodeja.string | null
Koko lyhytlinkki, esimerkiksi
https://getqr.sh/x7Kd2p1.string | null
Lyhytlinkin verkkotunnus.
string | null
Lyhytlinkin slug.
boolean
true, kun slug on valittu itse eikä luotu automaattisesti.string | null
Kohde, johon lyhytlinkki ohjaa.
string | null
Kohde iOS-kävijöille
app-QR-koodeissa.string | null
Kohde Android-kävijöille
app-QR-koodeissa.integer
Skannausten kokonaismäärä.
object
Käyttösäännöt. Itse salasanaa ei koskaan palauteta. Katso Käyttösäännöt.
string
Vain luku.
custom on ulkoasu, jota API voi muokata kokonaan. branded ja ai ovat hallintapaneelissa tehty brändätty tai tekoälyllä luotu ulkoasu. API ei voi muokata sen kuvaa, mutta säilyttää sen, kun muutat muita kenttiä.object
Tallennettu ulkoasu:
styles, frameOptions ja logoOptions, kukin objekti tai null. Niillä on sama rakenne kuin pyynnön kentillä, joten voit lähettää ne takaisin. Katso Mukauttaminen.object | null
pdf-, image- tai video-QR-koodin tiedosto: id, name ja size tavuina.string | null
Vain luku. Hallintapaneelissa tehdyn
app-QR-koodin näyttönimi.object | null
Vain luku. Hallintapaneelissa tehty
pdf-QR-koodi, jossa on useita tiedostoja: title, layout ja files.object | null
Vain luku. Hallintapaneelissa tehty
image-QR-koodi, jossa on useita kuvia: title, layout ja files.string
Luontipäivä, ISO 8601.
string
Viimeisimmän päivityksen päivä, ISO 8601.
password, userId, workspaceId, projectId) ei koskaan palauteta.
Listaa QR-koodit
GET /api/v1/qrs
Palauttaa työtilasi QR-koodit sivu kerrallaan.
integer
oletus:"1"
Palautettava sivu, 1 tai suurempi.
integer
oletus:"100"
QR-koodeja sivua kohti, 1–100. Suurempi arvo hylätään.
string
Hakee QR-koodin nimestä. Yli 2 merkin haut hakevat myös tallennetusta
data-arvosta. Linkkityypeillä tallennettu data on lyhytlinkki, joten kohde-URL-osoitteita ei voi hakea.string
oletus:"createdAt"
Lajittelukenttä:
createdAt, updatedAt, clicks (skannaukset yhteensä), lastClicked (viimeisin skannaus) tai type. type lajittelee aina laskevasti ja ohittaa parametrin sortOrder.string
oletus:"desc"
Lajittelusuunta:
asc tai desc.boolean
oletus:"false"
Sisällytä keskeytetyt QR-koodit.
boolean
oletus:"false"
Palauta vain keskeytetyt QR-koodit. Ohittaa parametrin
showArchived.true tai false. Pyydä seuraava sivu niin kauan kuin pagination.hasMore on true. Katso Sivutus.
Luo QR-koodi
POST /api/v1/qrs
Luo QR-koodin ja sen lyhytlinkin yhdessä. Vastaa 201 Created ja palauttaa uuden QR-koodin.
string
Oma uudelleenyritystunnisteesi. Kun toistat pyynnön samalla avaimella 24 tunnin sisällä, saat alkuperäisen vastauksen, eikä toista QR-koodia luoda. Katso Uudelleenyritykset ja kaksoiskappaleet.
string
vaadittu
Mitä QR-koodi koodaa. Tämä määrää myös muodon, jossa
data-kentän on oltava. Jokin arvoista website, pdf, image, video, whatsapp, social, wifi, app, feedback, vcard, sms, payment, location, multilink, email, event.string
vaadittu
Tyypin kuorma, joka tarkistetaan
qrType-arvoa vasten. Tyhjä merkkijono ohittaa tarkistuksen. Kunkin tyypin muoto on kohdassa QR-koodien data tyypeittäin.object
Lyhytlinkki, jonka kautta QR-koodi ohjautuu. Valinnainen: jos jätät sen pois,
link.url seuraa data-kenttää.string
QR-koodin nimi, joka näkyy hallintapaneelissa. Alun ja lopun välilyönnit poistetaan, 1–40 merkkiä. Jos jätät sen pois, QR-koodilla ei ole nimeä.
string
Vapaamuotoinen muistiinpano QR-koodista. Enintään 280 merkkiä.
string
pdf-, image- tai video-QR-koodin tiedosto, joka on ladattu vastaavalla targetilla. Tyypeillä vcard, social ja multilink valinnainen profiilikuva, joka on ladattu targetilla logo. Myös event hyväksyy sen, mutta sen sivu lukee kansikuvan kentästä data.fileId. Muut tyypit palauttavat 422. Lataa tiedosto ensin Tiedostot-päätepisteellä. Katso Tiedostot QR-koodeissa.string
Malli, jonka ulkoasu otetaan uuteen QR-koodiin. Lähettämäsi ulkoasukentät yhdistetään sen päälle. Brändätyn tai tekoälyllä luodun ulkoasun malli palauttaa
422 (art_template_unsupported). Tuntematon malli tai toisen työtilan malli palauttaa 404.object
Pisteiden ja kulmien muodot sekä värit. Katso Mukauttaminen.
object
QR-koodin ympärille piirretty kehys ja sen toimintakehote. Katso Mukauttaminen.
object
Logo keskellä: ehdotettu logo tai oma tiedostosi, joka on ladattu targetilla
logo. Tuntematon tiedosto, keskeneräinen lataus tai toisen targetin tiedosto hylätään. Katso Mukauttaminen.object
Aikataulu, skannausraja ja salasanasuojaus. Katso Käyttösäännöt.
boolean
Onko QR-koodi keskeytetty.
true luo sen valmiiksi keskeytettynä: skannaukset näyttävät kohteen sijaan taukosivun.Uudelleenyritykset ja kaksoiskappaleet
- Avaimen kanssa.
Idempotency-Key-otsakkeen kanssa vastaus toistetaan 24 tunnin ajan. - Ilman avainta. 30 sekunnin sisällä lähetetty identtinen runko käsitellään kaksoiskappaleena.
- Toistot. Toisto palauttaa tallennetun vastauksen otsakkeella
x-idempotent-replay: true. Uusi QR-koodi palauttaa arvonfalse. - Kesken. Toinen pyyntö ensimmäisen ollessa vielä käynnissä saa vastauksen
409 conflict. - Epäonnistumiset. Epäonnistunut luonti vapauttaa avaimen heti, joten voit yrittää uudelleen samalla avaimella.
- Parhaan yrityksen periaate. Jos suojaus ei ole käytettävissä, luonnit menevät läpi ilman suojausta.
Hae QR-koodi
GET /api/v1/qrs/{qrId}
Palauttaa QR-koodin lyhytlinkkeineen, käyttösääntöineen, ulkoasuineen ja tiedostopohjaisilla tyypeillä myös tiedostoineen.
string
vaadittu
QR-koodin tunnus listauksen tai luonnin vastauksesta.
Päivitä QR-koodi
PATCH /api/v1/qrs/{qrId}
Muuttaa QR-koodin sisältöä, kohdetta, ulkoasua tai käyttösääntöjä. Lähetä vain ne kentät, joita haluat muuttaa. Vastaa päivitetyllä QR-koodilla.
string
vaadittu
QR-koodin tunnus.
templateId. Ei hyväksytä.link. Osittainen. Nykyinen kohde säilyy, kun jätätlink.url-kentän pois.link.domainjalink.keypalauttavat422: painettu koodi koodaa juuri lyhytlinkin, joten luo uusi QR-koodi, jos haluat käyttää eri linkkiä.data. Tarkistetaan lopputuloksen tyyppiä vasten vain, kundatataiqrTypemuuttuu.qrType-arvon vaihtaminen ilman sopivaadata-arvoa hylätään. Katso Tyypin vaihtaminen.- Ulkoasu.
styles,frameOptionsjalogoOptionsyhdistetään tallennettuun ulkoasuun, joten osittainen objekti muuttaa vain siinä mainitut asiat. Toisen logon valinta korvaa logon mutta säilyttää sen koon. access. Kukin avain käsitellään, jos se on mukana.nulltyhjentää säännön. Käyttösäännöt kuuluvataccess-objektiin: niiden lähettäminenlink-objektissa palauttaa422.archived. Keskeyttää tai aktivoi uudelleen QR-koodin ja sen lyhytlinkin yhdessä, kuten Keskeytä ja Aktivoi uudelleen.
Aseta keskeytystila
PUT /api/v1/qrs/{qrId}
Asettaa keskeytystilan suoraan. Keskeytä ja Aktivoi uudelleen tekevät saman ja ovat selkeämpiä lukea.
string
vaadittu
QR-koodin tunnus.
boolean
vaadittu
true keskeyttää QR-koodin, false aktivoi sen uudelleen.Keskeytä QR-koodi
POST /api/v1/qrs/{qrId}/pause
Estää QR-koodia ohjaamasta kohteeseensa: skannaukset näyttävät sen sijaan taukosivun. Painettu koodi ja sen lyhytlinkki pysyvät voimassa. Ei pyynnön runkoa.
string
vaadittu
QR-koodin tunnus.
Aktivoi QR-koodi uudelleen
POST /api/v1/qrs/{qrId}/activate
Saa keskeytetyn QR-koodin taas ohjaamaan kohteeseensa. Mahdollinen aikataulu ja skannausraja ovat edelleen voimassa. Ei pyynnön runkoa.
string
vaadittu
QR-koodin tunnus.
Monista QR-koodi
POST /api/v1/qrs/{qrId}/duplicate
Luo kopion, jolla on sama sisältö ja ulkoasu. Ei pyynnön runkoa. Vastaa 201 Created ja palauttaa uuden QR-koodin.
string
vaadittu
Kopioitavan QR-koodin tunnus.
- Lyhytlinkki. Kopio saa oman lyhytlinkin, jossa on satunnainen slug työtilan oletusverkkotunnuksessa, ei alkuperäisen QR-koodin verkkotunnuksessa. Sen skannaukset lasketaan erikseen.
- Nimi. Nimeen lisätään pääte
(Copy). Tulos pysyy enintään 40 merkissä: pitkää nimeä lyhennetään ensin. Nimetön QR-koodi pysyy nimettömänä. - Ei kopioida. Käyttösääntöjä (salasana, aikataulu, skannausraja) ja keskeytystilaa. Kopio on aina aktiivinen.
- Tiedostot. PDF- ja kuvatiedostot, myös nippujen ja gallerioiden tiedostot, kopioidaan, joten kopio omistaa ne. Videotiedostot ja ulkoasun tiedostot, kuten logot, jaetaan lähteen kanssa.
Poista QR-koodi
DELETE /api/v1/qrs/{qrId}
Poistaa QR-koodin ja sen lyhytlinkin. Vastaa poistetulla tunnuksella.
string
vaadittu
QR-koodin tunnus.
string
Poistetun QR-koodin tunnus.
boolean
Aina
true.Lataa QR-koodin kuva
GET /api/v1/qrs/{qrId}/download
Piirtää QR-koodin ulkoasuineen ja palauttaa tiedoston.
string
vaadittu
Piirrettävän QR-koodin tunnus listauksen tai luonnin vastauksesta.
string
oletus:"jpg"
Tulostusmuoto:
jpg, png, svg, pdf (A4-sivu) tai eps. Brändätyn tai tekoälyllä luodun ulkoasun voi ladata vain muodoissa jpg, png tai pdf.integer
oletus:"1024"
Kuvan koko pikseleinä:
1024, 2048 tai 4096. svg ja pdf ohittavat sen. Brändätyn tai tekoälyllä luodun ulkoasun voi ladata vain koossa 1024.- Runko. Vastauksen runko on tiedosto. Ehdotettu tiedostonimi on
Content-Disposition-otsakkeessa, ja se muodostetaan nimestä tai nimettömälle QR-koodille arvostaqr-code. - Välimuisti. Vastauksissa on
ETagjaCache-Control: private, max-age=3600, must-revalidate. LähetäETagtakaisinIf-None-Match-otsakkeessa, niin saat vastauksen304 Not Modified, kun QR-koodi ei ole muuttunut. - Virheet. Tukematon muoto tai resoluutio palauttaa
400 bad_request. Virheviesti kertoo syyn:qr_download_invalid_format,qr_download_invalid_resolution,qr_download_art_format_unsupportedtaiqr_download_art_resolution_unsupported.
Käyttösäännöt
Lähetä luonnissa tai päivityksessäaccess-objekti, kun haluat ajoittaa alun ja lopun, rajoittaa skannausten määrää tai vaatia salasanan. Pois jätetyt säännöt pysyvät ennallaan, ja null tyhjentää säännön. Koko toiminta esimerkkeineen on kuvattu kohdassa Käyttösäännöt.
Ulkoasuobjektit
styles, frameOptions ja logoOptions määrittävät pisteiden ja kulmien muodot, värit, kehyksen ja logon. Ne toimivat samoin QR-koodeissa, malleissa ja joukkoluonneissa. Tuntemattomat muodot, kehykset tai logot hylätään. Kaikki hyväksytyt arvot ja esimerkki ovat kohdassa Mukauttaminen.
Yleisiä ongelmia
422, kun asetan salasanan, aikataulun tai skannausrajan
422, kun asetan salasanan, aikataulun tai skannausrajan
Lähetä sääntö
access-objektissa, ei link-objektissa.422, kun muutan link.domain- tai link.key-arvoa
422, kun muutan link.domain- tai link.key-arvoa
Lyhytlinkkiä ei voi muuttaa luonnin jälkeen, koska painettu koodi koodaa sen. Luo sen sijaan uusi QR-koodi.
422 "Expected … for qrType"
422 "Expected … for qrType"
data ei vastaa qrType-arvon muotoa. Tarkista tyyppi kohdasta QR-koodien data tyypeittäin.409 conflict QR-koodia luotaessa
409 conflict QR-koodia luotaessa
Identtinen luonti on vielä käynnissä, tai
link.key on varattu. Yritä uudelleen, kun ensimmäinen pyyntö on valmis. Idempotency-Key-otsakkeen kanssa uusi yritys palauttaa alkuperäisen QR-koodin.Lataus on JPEG eikä PNG
Lataus on JPEG eikä PNG
Parametrit ovat
format ja resolution, ja format-parametrin oletus on jpg. Lähetä format=png.404 QR-koodille, jonka näen hallintapaneelissa
404 QR-koodille, jonka näen hallintapaneelissa
Jokainen pyyntö suoritetaan API-avaimesi työtilassa. Tarkista, että QR-koodi kuuluu siihen. Katso Todennus.