Siirry pääsisältöön
GetQR API on beetavaiheessa, ja se on käytettävissä valituissa työtiloissa. Yksityiskohdat voivat muuttua ennen yleistä julkaisua.
GetQR API todentaa jokaisen pyynnön tilisi API-avaimella. Jokaisella käyttäjällä on yksi avain, ja se toimii sinun nimissäsi yhdessä työtilassa.

​
Ennen kuin aloitat

  • Olet työtilan omistaja tai muokkaaja. Katselijat eivät voi luoda tai käyttää API-avainta.
  • Työtilan omistajalla on aktiivinen tilaus.

​
Luo API-avaimesi

1

Avaa tilisi asetukset

Avaa tilisi asetukset ja siirry kohtaan API.
2

Luo avain

Napsauta Generate API key.
3

Kopioi avain

Näytä avain ja kopioi se. Avaimet alkavat merkkijonolla sk_live_.
Voit näyttää ja kopioida avaimen uudelleen milloin tahansa. Asetuksissa näkyy myös, milloin avain luotiin ja milloin sitä viimeksi käytettiin.

​
Pyyntöjen todentaminen

Lähetä avain Bearer-tunnuksena jokaisen pyynnön Authorization-otsakkeessa:
Tilatarkistus on ainoa päätepiste, joka toimii ilman avainta.

​
Käyttöoikeudet ja roolit

  • Roolit. Vain työtilan omistaja ja muokkaajat voivat luoda ja käyttää API-avainta. Katselijat eivät voi.
  • Työtila. Jokainen avain kuuluu yhteen työtilaan, ja jokainen pyyntö suoritetaan siinä työtilassa. Työtilan tunnusta ei tarvitse välittää.
  • Reaaliaikaiset tarkistukset. Käyttöoikeus tarkistetaan jokaisen pyynnön yhteydessä nykyistä rooliasi ja työtilan omistajan tilausta vasten. Oma tilauksesi ei vaikuta. Jos roolisi muuttuu katselijaksi tai omistajan tilaus päättyy, pyynnöt palauttavat 403, kunnes käyttöoikeus palautuu. Uutta avainta ei tarvita.
  • Poistaminen. Jos sinut poistetaan työtilasta, API-avaimesi poistetaan. Jos sinut lisätään takaisin, luo uusi avain.

​
Avaimen luominen uudelleen

Luo avain uudelleen, jos se vuotaa tai joku, jolla ei pitäisi olla sitä, saa sen käyttöönsä.
Nykyinen avaimesi lakkaa toimimasta heti. Kaikki sitä käyttävät sovellukset ja integraatiot lakkaavat toimimasta, kunnes päivität niihin uuden avaimen.
1

Napsauta Regenerate

Siirry tilisi asetuksissa kohtaan API ja napsauta Regenerate.
2

Vahvista

Napsauta Regenerate key.
3

Päivitä sovelluksesi

Kopioi uusi avain ja korvaa vanha kaikkialla, missä käytät sitä.

​
Pidä avaimesi turvassa

Käsittele avainta kuin salasanaa: kuka tahansa, jolla se on, voi luoda, muuttaa ja poistaa QR-koodeja työtilassasi.
  • Säilytä se ympäristömuuttujassa tai salaisuuksien hallintatyökalussa, ei lähdekoodissa.
  • Kutsu APIa vain palvelimeltasi. Älä koskaan laita avainta verkkosivustoon, mobiilisovellukseen tai mihinkään muuhun, jota käyttäjät voivat tutkia.
  • Jaa se vain kehittäjille, jotka tarvitsevat sitä.
  • Luo se uudelleen heti, kun epäilet sen vuotaneen.

​
Yleisiä ongelmia

Avain on luotu uudelleen, tai sinut on poistettu työtilasta ja avain on poistettu. Kopioi nykyinen avain tilisi asetuksista tai luo uusi.
Tarkista, että roolisi on omistaja tai muokkaaja ja että työtilan omistajan tilaus on aktiivinen. Avain toimii taas heti, kun käyttöoikeus palautuu.
API on beetavaiheessa, eikä sitä ole vielä otettu käyttöön työtilassasi.
Ne näkyvät vain työtilan omistajalle ja muokkaajille ja vain työtiloissa, joissa API on käytössä.

​
Mitä seuraavaksi

API:n esittely

Virheet