Kaj je API ključ

API ključ je skrivni niz, ki dokazuje, da ima drug sistem dovoljenje za branje vaših podatkov. Deluje kot geslo – le da ga namesto osebe vnese program, veljavnost pa traja, dokler ga ne prekličete.

Dobro je vedeti: urejevalnik in račun Gatherino sta v angleščini ali češčini. Obrazci, ki jih izpolnjujejo vaši izpolnjevalci, so lahko prikazani v 18 jezikih, vključno s slovenščino.

Ključ ustvarite v nastavitvah in je prikazan natanko enkrat. Takoj ga shranite v okoljsko spremenljivko ali upravitelja skrivnosti na svojem strežniku; kasneje ga ne morete prebrati, ker je shranjen v obliki, iz katere izvirne vrednosti ni mogoče izpeljati.

Najpogostejša napaka je, da ključ postavite v JavaScript na strani. Izvorna koda brskalnika je javna – kdorkoli lahko kopira ključ in prenese vse odgovore iz vseh vaših obrazcev. Klici API-ja zato sodijo na strežnik, ki hrani ključ in vrača le tisto, kar je namenjeno javnosti.

Če pride do uhajanja ključa, ne preiskujte, ali ga je kdo uporabil – prekličite ga in izdajte novega. Preklic je takojšen, stari ključ pa preneha delovati.

V praksi

  • Ključ sodi v okoljsko spremenljivko na strežniku, ne v repozitorij in ne na spletno stran.
  • Priporočamo ločen ključ za vsako integracijo, da lahko prekličete samo tisto eno.
  • Ključ zamenjajte, ko kdo, ki ga je poznal, odide.

Pogosta vprašanja

Kje ustvarim API ključ?

V Nastavitve → API ključi. Prikazan je samo enkrat.

Kako se ključ pošilja?

V glavi Authorization: Bearer <ključ> ali v glavi x-api-key.

Kaj se zgodi, ko ključ prekličem?

Preneha delovati takoj, integracije, ki ga uporabljajo, pa prejmejo napako 401.

Sorodno

Preizkusite Gatherino brezplačno

Brezplačni paket: 3 obrazci in 100 odgovorov na mesec. Brez kreditne kartice, podatki so gostovani v EU.

Začnite brezplačno →