Automatizācija un izstrādātāji
API atslēgas
Izveidojiet atslēgas, nosakiet to tvērumu un rotējiet tās, lai autentificētu piekļuvi API.
API atslēgas autentificē programmātisku piekļuvi PeekHire — gan REST API, gan jūsu bezkoda automatizācijām.
Atslēgas izveide
- Dodieties uz Izstrādātāju rīki → API atslēgas → Izveidot.
- Piešķiriet atslēgai aprakstošu nosaukumu (piem., Zapier integrācija), lai atcerētos, kam tā paredzēta.
- Nokopējiet atslēgas vērtību, kad tā tiek parādīta — drošības nolūkos jūs to vēlreiz vairs nevarēsiet apskatīt.
Atslēgas izmantošana
Nosūtiet atslēgu kā bearer tokenu katrā pieprasījumā:
curl https://your-api-host/api/v1/applications \
-H "Authorization: Bearer YOUR_API_KEY"
Atļaujas
Katrai atslēgai ir atļaujas, kas ierobežo, ko tā var darīt:
- Lasīšana — iegūt datus (uzskaitīt un izgūt kampaņas, pieteikumus, lietotājus).
- Rakstīšana — izveidot vai mainīt datus.
Piešķiriet tikai to, kas integrācijai nepieciešams (mazāko nepieciešamo piekļuvi). Tikai lasīšanas atslēga ir pietiekama, lai sinhronizētu datus izklājlapā vai informācijas panelī; pievienojiet Rakstīšana tikai tad, ja integrācijai ir kaut kas jāmaina PeekHire.
Atslēgu drošība
- Izturieties pret atslēgām kā pret parolēm. Ikviens, kam ir atslēga, var rīkoties ar jūsu datiem.
- Nekad neiekļaujiet atslēgas repozitorijā un neievietojiet tās klienta puses kodā.
- Katrai integrācijai izmantojiet atsevišķu atslēgu, lai varētu atsaukt vienu, neietekmējot pārējās.
- Glabājiet atslēgas noslēpumu pārvaldniekā vai sava rīka akreditācijas datu glabātuvē, nevis vienkāršā tekstā.
Rotēšana un atsaukšana
Ja atslēga ir atklāta — vai arī jūs vienkārši rotējat atslēgas pēc grafika — izveidojiet jaunu atslēgu, atjauniniet integrāciju un pēc tam izdzēsiet veco. Atslēgas dzēšana nekavējoties atsauc tās piekļuvi.