API:n esittely

GetQR API on beetavaiheessa, ja se on käytettävissä valituissa työtiloissa. Yksityiskohdat voivat muuttua ennen yleistä julkaisua.

GetQR API on REST-rajapinta niihin toimintoihin, joita teet hallintapaneelissa: QR-koodien luomiseen ja päivittämiseen, niiden kuvien lataamiseen, skannausanalytiikan lukemiseen ja raporttien vientiin. Todenna pyynnöt tilisi API-avaimella ja kutsu versioituja päätepisteitä polun /api/v1 alla.

Mitä voit tehdä

QR-koodit

Luo, listaa, päivitä, keskeytä, monista, poista ja lataa QR-koodeja.

Analytiikka

Skannausten kokonaismäärät ja erittelyt yhdelle QR-koodille tai koko työtilalle.

Raportit

Vie kertaluonteinen raportti tai ajasta toistuvat raporttisähköpostit.

Mallit

Tallenna ulkoasuja ja käytä niitä uusissa QR-koodeissa.

QR-koodien joukkoluonti

Luo jopa 100 QR-koodia kerralla JSON-datasta tai CSV-tiedostosta.

Tiedostot

Lataa QR-koodeillesi PDF-tiedostoja, kuvia, videoita ja logoja.

Tilatarkistus

Tarkista, että API toimii. API-avainta ei tarvita.

Oppaat

QR-tyypit

Datan muoto kullekin 16 QR-tyypistä.

Mukauttaminen

Pisteiden tyylit, kulmat, värit, kehykset ja logot.

Käyttösäännöt

Aikataulut, skannausrajat, salasanat, keskeyttäminen ja poistaminen.

Perus-URL

Kaikki päätepisteet ovat saman perus-URL:n alla:

https://getqr.com/api/v1

Versiointi

API-versio on osa polkua: jokainen päätepiste on polun /api/v1/ alla.

Yhteensopivuuden rikkovat muutokset julkaistaan uuden versioetuliitteen alla, kuten /api/v2/, ja /api/v1/ toimii edelleen.
Lisäävät muutokset, kuten uudet valinnaiset kentät tai uudet päätepisteet, voivat ilmestyä v1:een. Ohita vastauksen kentät, joita koodisi ei tunnista.

Pika-aloitus

Hanki API-avaimesi

Luo tai näytä avaimesi tilisi asetuksissa. Katso Todennus.

Tarkista, että API on tavoitettavissa

curl https://getqr.com/api/v1/health

Vastaus on { "status": "ok", "version": "v1" }.

Luo ensimmäinen QR-koodisi

curl -X POST "https://getqr.com/api/v1/qrs" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: first-qr-0001" \
  -d '{
    "qrType": "website",
    "data": "https://example.com",
    "title": "Landing page"
  }'

API vastaa koodilla 201 ja palauttaa uuden QR-koodin, jossa ovat sen id ja shortLink.

Lataa kuva

curl "https://getqr.com/api/v1/qrs/{qrId}/download?format=png&resolution=1024" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  --output qr-code.png

Pyynnöt ja vastaukset

Muoto. Lähetä pyyntöjen rungot JSON-muodossa otsakkeella Content-Type: application/json. Poikkeus on joukkoluonnin CSV-lataus, joka käyttää muotoa multipart/form-data.
Vastaukset. Vastaukset ovat JSON-muotoisia. Lataukset, kuten QR-kuvat ja joukkoluonnin ZIP-arkistot, palauttavat itse tiedoston.
Päivämäärät. Päivämäärät ovat ISO 8601 -merkkijonoja UTC-ajassa, esimerkiksi 2026-08-01T10:00:00.000Z.
Kyselyparametrit. Totuusarvoparametrit ottavat merkkijonot true tai false.
Osittaiset päivitykset. PATCH-päätepisteet muuttavat vain lähettämäsi kentät.
Salaisuudet. Vastaukset eivät koskaan sisällä salasanoja tai sisäisiä tunnisteita. Salasanalla suojattu QR-koodi kertoo vain passwordProtected: true.
Työtila. Jokainen pyyntö suoritetaan työtilassa, johon API-avaimesi kuuluu. Työtilan tunnusta ei välitetä. Katso Käyttöoikeudet ja roolit.
Virheet. Epäonnistuneet pyynnöt palauttavat error-objektin, jossa on pysyvä code. Katso Virheet.

Sivutus

Listauspäätepisteet (QR-koodit, mallit ja ajastetut raportit) ottavat kaksi kyselyparametria:

Parametri	Kuvaus
`page`	Palautettava sivu. Oletus `1`.
`pageSize`	Tuloksia sivua kohti, enintään `100`. Oletus `100`.

Ne vastaavat data-taulukolla ja pagination-objektilla:

{
  "data": [ … ],
  "pagination": { "page": 1, "pageSize": 50, "total": 128, "hasMore": true }
}

Kenttä	Kuvaus
`page`	Saamasi sivu.
`pageSize`	Saamasi sivun koko.
`total`	Tulosten määrä kaikilla sivuilla yhteensä.
`hasMore`	`true`, niin kauan kuin seuraava sivu on odottamassa.

Pyydä seuraava sivu niin kauan kuin hasMore on true. Yli 100:n pageSize palauttaa virheen 422.

Idempotenssi

Verkkovirheen jälkeen et välttämättä tiedä, menikö pyyntö perille. Jotta voit yrittää QR-koodin luontia turvallisesti uudelleen, lähetä Idempotency-Key-otsake, jonka arvon valitset itse ja joka on yksilöllinen:

-H "Idempotency-Key: order-4821-qr"

Kun toistat pyynnön samalla avaimella 24 tunnin sisällä, saat alkuperäisen vastauksen, eikä toista QR-koodia luoda.
Vastausotsake x-idempotent-replay on true toistetulle vastaukselle ja false uudelle.
Jos ensimmäinen saman avaimen pyyntö on vielä käynnissä, API vastaa 409 conflict. Yritä uudelleen, kun se on valmis.
Jos käytät avainta uudelleen eri pyynnön rungolla, vastaus on 422 unprocessable_entity.
Ilman otsaketta 30 sekunnin sisällä lähetetty identtinen pyynnön runko käsitellään kaksoiskappaleena.

Joukkoluonnit ottavat sen sijaan pyynnön rungossa kentän idempotencyKey. Katso QR-koodien joukkoluonti.

Käyttörajoitukset

Kukin API-avain voi lähettää enintään 600 pyyntöä minuutissa. Katso Käyttörajoitukset.

API

Mitä voit tehdä

QR-koodit

Analytiikka

Raportit

Mallit

QR-koodien joukkoluonti

Tiedostot

Tilatarkistus

Oppaat

QR-tyypit

Mukauttaminen

Käyttösäännöt

Perus-URL

Versiointi

Pika-aloitus

Pyynnöt ja vastaukset

Sivutus

Idempotenssi

Käyttörajoitukset

Tulossa myöhemmin

Mitä seuraavaksi

Todennus

QR-koodit

​Mitä voit tehdä

QR-koodit

Analytiikka

Raportit

Mallit

QR-koodien joukkoluonti

Tiedostot

Tilatarkistus

​Oppaat

QR-tyypit

Mukauttaminen

Käyttösäännöt

​Perus-URL

​Versiointi

​Pika-aloitus

​Pyynnöt ja vastaukset

​Sivutus

​Idempotenssi

​Käyttörajoitukset

​Tulossa myöhemmin

​Mitä seuraavaksi

Todennus

QR-koodit

Mitä voit tehdä

Oppaat

Perus-URL

Versiointi

Pika-aloitus

Pyynnöt ja vastaukset

Sivutus

Idempotenssi

Käyttörajoitukset

Tulossa myöhemmin

Mitä seuraavaksi