Лого на PeekHire
Автоматизация и разработчици

Ключове за API

Създавайте, задавайте обхват и ротирайте ключовете, които удостоверяват достъпа до API.

API ключовете удостоверяват програмния достъп до PeekHire — както до REST API, така и до автоматизациите ви без код.

Създаване на ключ

  1. Отидете на Инструменти за разработчици → API ключове → Създаване.
  2. Дайте на ключа описателно име (напр. Zapier интеграция), за да помните за какво служи.
  3. Копирайте стойността на ключа, когато се покаже — от съображения за сигурност няма да можете да я видите отново след това.

Използване на ключ

Изпращайте ключа като bearer token при всяка заявка:

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

Разрешения

Всеки ключ има разрешения, които ограничават какво може да прави:

  • Четене — извличане на данни (списък и преглед на кампании, кандидатури, потребители).
  • Запис — създаване или промяна на данни.

Давайте само това, което е нужно на интеграцията (най-малко необходими права). Ключ само за четене е достатъчен, за да синхронизирате данни в електронна таблица или табло; добавяйте Запис само когато интеграцията трябва да променя нещо в PeekHire.

Защита на ключовете

  • Отнасяйте се към ключовете като към пароли. Всеки, който има ключ, може да действа с вашите данни.
  • Никога не записвайте ключове в хранилище или в клиентски код.
  • Използвайте отделен ключ за всяка интеграция, за да можете да отнемете един, без да засегнете останалите.
  • Съхранявайте ключовете в мениджър на тайни или в хранилището за идентификационни данни на инструмента ви, а не в обикновен текст.

Ротация и отнемане

Ако ключ бъде изложен на риск — или просто сменяте ключовете по график — създайте нов ключ, актуализирайте интеграцията си и след това изтрийте стария. Изтриването на ключ отнема достъпа му незабавно.