PeekHire logotipas
Automatizavimas ir programuotojai

API raktai

Kurkite, apribokite pagal teises ir keiskite raktus, kuriais autentifikuojama API prieiga.

API raktai autentifikuoja programinę prieigą prie PeekHire — tiek prie REST API, tiek prie tavo automatizacijų be kodo.

Rakto kūrimas

  1. Eik į Kūrėjo įrankiai → API raktai → Sukurti.
  2. Suteik raktui aiškų pavadinimą (pvz., Zapier integracija), kad prisimintum, kam jis skirtas.
  3. Nukopijuok rakto reikšmę, kai ji parodoma — saugumo sumetimais vėliau jos nebegalėsi pamatyti.

Rakto naudojimas

Siųsk raktą kaip bearer prieigos raktą kiekvienoje užklausoje:

curl https://your-api-host/api/v1/applications \
  -H "Authorization: Bearer YOUR_API_KEY"

Leidimai

Kiekvienas raktas turi leidimus, kurie apriboja, ką jis gali daryti:

  • Skaitymas — gauti duomenis (peržiūrėti ir gauti kampanijas, paraiškas, naudotojus).
  • Rašymas — kurti arba keisti duomenis.

Suteik tik tuos leidimus, kurių integracijai reikia (mažiausių privilegijų principas). Tik skaitymo raktas yra pakankamas duomenims sinchronizuoti į skaičiuoklę ar ataskaitų sritį; pridėk Rašymas tik tada, kai integracijai reikia ką nors keisti PeekHire.

Raktų saugumas

  • Elkis su raktais kaip su slaptažodžiais. Kiekvienas, turintis raktą, gali veikti su tavo duomenimis.
  • Niekada neįkelk raktų į repozitoriją ir nedėk jų į kliento pusės kodą.
  • Naudok atskirą raktą kiekvienai integracijai, kad galėtum panaikinti vieną nepaveikdamas kitų.
  • Saugok raktus paslapčių tvarkyklėje arba savo įrankio prisijungimo duomenų saugykloje, o ne paprastu tekstu.

Keitimas ir panaikinimas

Jei raktas buvo atskleistas — arba tiesiog reguliariai keiti raktus pagal grafiką — sukurk naują raktą, atnaujink integraciją, tada ištrink senąjį. Ištrynus raktą, jo prieiga panaikinama iš karto.