PeekHire logo
Automatiseerimine ja arendajad

API võtmed

Loo, määra õigused ja vaheta võtmeid, millega autentitakse API juurdepääs.

API võtmed autentivad programmipõhist juurdepääsu PeekHire platvormile — nii REST API kui ka sinu koodivabadele automatiseeringutele.

Võtme loomine

  1. Mine lehele Arendaja tööriistad → API võtmed → Loo.
  2. Anna võtmele kirjeldav nimi (nt Zapier integration), et mäletaksid, mille jaoks see on.
  3. Kopeeri võtme väärtus siis, kui seda näidatakse — turvalisuse huvides ei saa sa seda hiljem enam uuesti vaadata.

Võtme kasutamine

Saada võti iga päringuga bearer tokenina:

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

Õigused

Igal võtmel on õigused, mis piiravad seda, mida sellega teha saab:

  • Lugemine — andmete hankimine (kampaaniate, kandideerimiste ja kasutajate loetlemine ning vaatamine).
  • Kirjutamine — andmete loomine või muutmine.

Anna ainult need õigused, mida integratsioon vajab (vähimate õiguste põhimõte). Ainult lugemisõigusega võtmest piisab, et sünkroonida andmeid arvutustabelisse või töölauale; lisa Kirjutamine ainult siis, kui integratsioon peab PeekHire andmeid muutma.

Võtmete turvaline hoidmine

  • Käsitle võtmeid nagu paroole. Igaüks, kellel on võti, saab sinu andmetega tegutseda.
  • Ära kunagi salvesta võtmeid koodihoidlasse ega pane neid kliendipoolsesse koodi.
  • Kasuta iga integratsiooni jaoks eraldi võtit, et saaksid ühe tühistada ilma teisi mõjutamata.
  • Hoia võtmeid saladuste halduris või oma tööriista mandaatide hoidlas, mitte lihttekstina.

Vahetamine ja tühistamine

Kui võti on avalikuks saanud — või kui vahetad võtmeid lihtsalt kindla graafiku alusel — loo uus võti, uuenda oma integratsiooni ja seejärel kustuta vana. Võtme kustutamine tühistab selle juurdepääsu kohe.