Logotip PeekHire
Avtomatizacija in razvijalci

REST API

Programsko berite in upravljajte kampanje, prijave in uporabnike.

REST API PeekHire omogoča, da vaša programska oprema dela z vašimi podatki za zaposlovanje. Je standardni HTTPS + JSON API, zato ga lahko uporablja vsak jezik ali orodje, ki zna pošiljati spletne zahteve.

Raziščite vsak endpoint, parameter in shemo v interaktivni referenci OpenAPI:

Odpri referenčno dokumentacijo API

Osnovni URL in različice

API uporablja različice. Vsi endpointi so pod predpono /api/v1, zato prihodnje spremembe ne bodo pokvarile vaše integracije.

Preverjanje pristnosti

Vsako zahtevo preverite z API ključem, poslanim kot bearer token:

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

API ključa nikoli ne vdelajte v kodo na strani odjemalca ali v javni repozitorij.

Do česa lahko dostopate

API v1 pokriva glavne objekte za zaposlovanje:

  • Kampanje — prikažite seznam in pridobite vloge, za katere zaposlujete.
  • Prijave — prikažite seznam in pridobite prijave kandidatov.
  • Uporabniki — prikažite seznam in pridobite člane svojega delovnega prostora.

Odgovori so v JSON in vključujejo polja, ki jih vidite v aplikaciji, na primer naslov in status kampanje ali fazo in jezik prijave.

Paginacija in filtriranje

Endpointi s seznami vračajo rezultate po straneh. Uporabite parametre paginacije za premikanje po velikih naborih rezultatov in filtre, kjer so podprti, da pridobite samo tisto, kar potrebujete.

Napake

API uporablja standardne kode stanja HTTP — 2xx za uspeh, 4xx za težave z vašo zahtevo (na primer manjkajoč ali neveljaven ključ) in 5xx za nepričakovane napake strežnika. Odgovori z napakami vključujejo sporočilo z opisom, kaj je šlo narobe.

Povezano

Pregled

Avtomatizirajte PeekHire z API-jem, webhooki, orodji brez kode ali pomočnikom z umetno inteligenco.

Ključi API

Ustvarjajte, določajte obseg in rotirajte ključe, ki se uporabljajo za avtentikacijo dostopa do API.