REST API

PeekHire REST API ļauj tavai programmatūrai strādāt ar atlases datiem. Tā ir standarta HTTPS + JSON API, tāpēc to var izmantot jebkura valoda vai rīks, kas spēj veikt tīmekļa pieprasījumus.

Izpēti katru galapunktu, parametru un shēmu interaktīvajā OpenAPI atsaucē:

Bāzes URL un versiju pārvaldība

API ir versijota. Visi galapunkti atrodas zem /api/v1 prefiksa, lai turpmākās izmaiņas nesalauztu tavu integrāciju.

Autentifikācija

Autentificē katru pieprasījumu ar API atslēgu, kas nosūtīta kā bearer tokens:

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

Nekad neiegulsti API atslēgu klienta puses kodā vai publiskā repozitorijā.

Kam vari piekļūt

v1 API aptver galvenos atlases objektus:

• Kampaņas — uzskaiti un izgūsti amatus, kuriem pieņem darbā.
• Pieteikumi — uzskaiti un izgūsti kandidātu iesniegtos pieteikumus.
• Lietotāji — uzskaiti un izgūsti savas darbvietas dalībniekus.

Atbildes ir JSON formātā un ietver laukus, ko redzi lietotnē, piemēram, kampaņas nosaukumu un statusu vai pieteikuma posmu un valodu.

Lapošana un filtrēšana

Sarakstu galapunkti atgriež rezultātus lapās. Izmanto lapošanas parametrus, lai pārlūkotu lielas rezultātu kopas, un, kur tas tiek atbalstīts, filtrē, lai iegūtu tikai vajadzīgo.

Kļūdas

API izmanto standarta HTTP statusa kodus — 2xx panākumiem, 4xx problēmām ar tavu pieprasījumu (piemēram, trūkstoša vai nederīga atslēga) un 5xx negaidītām servera kļūdām. Kļūdu atbildēs ir iekļauts ziņojums, kas apraksta, kas nogāja greizi.

Saistītie materiāli

• API atslēgas
• Webhooks push paziņojumiem aptaujas vietā