Autentifikácia
Napojenie na Swiftyper API prebieha vyžiadaním API kľúča cez hlavičku X-Swiftyper-API-Key
alebo parameter api_key
.
API kľúče môžete spravovať prostredníctvom Vášho používateľského účtu.
API kľúče sú predvolene neobmedzené
API kľúče sú predvolene neobmedzené. Neobmedzené kľúče nie sú bezpečné, pretože ich môže používať ktokoľvek a odkiaľkoľvek. Pre produkčné aplikácie odporúčame nastaviť obmedzenia API kľúča nakoľko pomáhajú zabrániť neoprávnenému použitiu a vyčerpávaniu kvót. Obmedzenia určujú, ktoré webové stránky alebo IP adresy môžu používať API kľúč.
Volanie API
Všetky API požiadavky musia byť smerované prostredníctvom protokolu HTTPS. Požiadavky smerované cez protokol HTTP nebudú spracované. Pri všetkých požiadavkách je nevyhnutná autentifikácia.
Príklad volania API
curl -X POST https://api.swiftyper.sk/v1/places/regions \
-H 'X-Swiftyper-API-Key: 2SN360bLw7lI7KB9Awu5w8oYvCWv17bsA1NAboFNo01Y' \
-d country=SK
V niektorých príkladoch tejto dokumentácie uvádzame testovací API kľúč, vďaka ktorému si môžete okamžite vyskúšať vybrané funkcie API.