PeekHire-logo
Automaatio ja kehittäjät

API-avaimet

Luo, rajaa käyttöoikeudet ja kierrätä avaimia, joilla API-käyttö todennetaan.

API-avaimet todentavat ohjelmallisen pääsyn PeekHireen — sekä REST API että no-code-automaatioihisi.

Avaimen luominen

  1. Siirry kohtaan Kehittäjätyökalut → API-avaimet → Luo.
  2. Anna avaimelle kuvaava nimi (esim. Zapier-integraatio), jotta muistat, mihin sitä käytetään.
  3. Kopioi avaimen arvo, kun se näytetään — turvallisuussyistä et voi nähdä sitä enää myöhemmin.

Avaimen käyttäminen

Lähetä avain bearer-tokenina jokaisessa pyynnössä:

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

Käyttöoikeudet

Jokaisella avaimella on käyttöoikeudet, jotka rajoittavat, mitä sillä voi tehdä:

  • Luku — hae dataa (listaa ja nouda kampanjoita, hakemuksia ja käyttäjiä).
  • Kirjoitus — luo tai muokkaa dataa.

Myönnä vain ne oikeudet, joita integraatio tarvitsee (vähimpien oikeuksien periaate). Vain luku -avain riittää datan synkronointiin taulukkolaskentaan tai koontinäkymään; lisää Kirjoitus vain, kun integraation täytyy muuttaa jotakin PeekHiressa.

Avainten pitäminen turvassa

  • Käsittele avaimia kuin salasanoja. Kuka tahansa avaimen saanut voi toimia datasi puolesta.
  • Älä koskaan tallenna avaimia repositorioon tai laita niitä asiakaspuolen koodiin.
  • Käytä jokaiselle integraatiolle omaa avainta, jotta voit kumota yhden avaimen vaikuttamatta muihin.
  • Säilytä avaimet salaisuuksien hallinnassa tai työkalusi tunnistetietovarastossa, älä pelkkänä tekstinä.

Avainten kierrättäminen ja kumoaminen

Jos avain paljastuu — tai jos yksinkertaisesti kierrätät avaimia aikataulun mukaan — luo uusi avain, päivitä integraatiosi ja poista sitten vanha. Avaimen poistaminen kumoaa sen käyttöoikeuden välittömästi.