REST API

PeekHire REST API omogućuje tvojem softveru rad s podacima za zapošljavanje. To je standardni HTTPS + JSON API, pa ga može koristiti bilo koji jezik ili alat koji može slati web zahtjeve.

Istraži svaki endpoint, parametar i shemu u interaktivnoj OpenAPI referenci:

Osnovni URL i verzioniranje

API je verzioniran. Svi endpointi nalaze se pod prefiksom /api/v1, tako da buduće promjene neće narušiti tvoju integraciju.

Autentifikacija

Autentificiraj svaki zahtjev pomoću API ključa poslanog kao bearer token:

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

Nikad nemoj ugrađivati API ključ u klijentski kod ili javni repozitorij.

Čemu možeš pristupiti

v1 API obuhvaća ključne objekte za zapošljavanje:

• Kampanje — prikaži popis i dohvaćaj pozicije za koje zapošljavaš.
• Prijave — prikaži popis i dohvaćaj prijave kandidata.
• Korisnici — prikaži popis i dohvaćaj članove svog radnog prostora.

Odgovori su u JSON formatu i uključuju polja koja vidiš u aplikaciji, poput naslova i statusa kampanje ili faze i jezika prijave.

Paginacija i filtriranje

Endpointi za popise vraćaju rezultate po stranicama. Koristi parametre paginacije za prolazak kroz velike skupove rezultata i filtriraj gdje je podržano kako bi dohvatio samo ono što ti treba.

Pogreške

API koristi standardne HTTP statusne kodove — 2xx za uspjeh, 4xx za probleme s tvojim zahtjevom (poput ključa koji nedostaje ili nije valjan) i 5xx za neočekivane pogreške poslužitelja. Odgovori o pogreškama uključuju poruku koja opisuje što je pošlo po zlu.

Povezano

• API ključevi
• Webhookovi za push obavijesti umjesto provjere u intervalima