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

REST API

Четете и управлявайте кампании, кандидатури и потребители програмно.

REST API на PeekHire позволява на вашия собствен софтуер да работи с данните ви за подбор. Това е стандартен HTTPS + JSON API, така че всеки език или инструмент, който може да прави уеб заявки, може да го използва.

Разгледайте всеки endpoint, параметър и схема в интерактивната OpenAPI справка:

Отвори справочника за API

Базов URL и версии

API е версиониран. Всички endpoint-и са под префикса /api/v1, така че бъдещи промени да не нарушат интеграцията ви.

Удостоверяване

Удостоверявайте всяка заявка с API ключ, изпратен като bearer token:

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

Никога не вграждайте API ключ в клиентски код или публично хранилище.

До какво имате достъп

v1 API покрива основните обекти за подбор:

  • Кампании — избройте и преглеждайте ролите, за които наемате.
  • Кандидатури — избройте и преглеждайте подадените кандидатури.
  • Потребители — избройте и преглеждайте членовете на вашето работно пространство.

Отговорите са в JSON и включват полетата, които виждате в приложението, като заглавие и статус на кампания или етап и език на кандидатура.

Странициране и филтриране

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

Грешки

API използва стандартни HTTP кодове за статус — 2xx за успех, 4xx за проблеми със заявката ви (например липсващ или невалиден ключ) и 5xx за неочаквани сървърни грешки. Отговорите за грешки включват съобщение, което описва какво се е объркало.

Свързани

Общ преглед

Автоматизирайте PeekHire с API, уебхукове, инструменти без код или AI асистент.

Ключове за API

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