API-avain
API-avain on salainen merkkijono, joka todistaa, että toinen järjestelmä saa lukea tietojasi. Se toimii kuten salasana, mutta sen syöttää ohjelma eikä ihminen, ja se on voimassa, kunnes kumoat sen.
Hyvä tietää: Gatherino-editori ja käyttäjätili ovat englanniksi tai tšekiksi. Vastaajille näytettävät lomakkeet voi näyttää 18 kielellä, myös suomeksi.
Avain luodaan asetuksissa ja näytetään vain kerran. Tallenna se heti palvelimesi ympäristömuuttujaan tai salaisuuksien hallintapalveluun. Myöhemmin sitä ei voi lukea uudelleen, koska se on tallennettu muodossa, josta alkuperäistä arvoa ei voi päätellä.
Yleisin virhe on sijoittaa avain sivun JavaScriptiin. Selaimen lähdekoodi on julkinen: kuka tahansa voi kopioida avaimen ja ladata jokaisen vastauksen kaikista lomakkeistasi. Rajapintakutsut kuuluvat siksi palvelimelle, joka pitää avainta hallussaan ja palauttaa vain sen, mikä on tarkoitettu julkiseksi.
Jos avain vuotaa, älä selvitä, onko sitä käytetty. Kumoa se ja luo uusi. Kumoaminen on välitöntä, ja vanha avain lakkaa toimimasta.
Käytännössä
- Avain kuuluu palvelinpuolen ympäristömuuttujaan, ei koodivarastoon eikä käyttöliittymään.
- Suosi erillistä avainta jokaiselle integraatiolle, jotta voit kumota vain yhden.
- Vaihda avain, kun avaimen tuntenut henkilö lähtee.
UKK
Mistä luon API-avaimen?
Asetukset → API-avaimet -kohdassa. Avain näytetään vain kerran.
Miten avain lähetetään?
Authorization: Bearer <avain> -otsakkeessa tai x-api-key-otsakkeessa.
Mitä tapahtuu, kun kumoan avaimen?
Se lakkaa toimimasta välittömästi, ja sitä käyttävät integraatiot saavat virhevastauksen 401.
Aiheeseen liittyvää
Kokeile Gatherinoa ilmaiseksi
Ilmainen paketti: 3 lomaketta ja 100 vastausta kuukaudessa. Ei luottokorttia, tiedot isännöidään EU:ssa.
Aloita ilmaiseksi →