REST API

PeekHire REST API võimaldab sinu enda tarkvaral sinu värbamisandmetega töötada. See on standardne HTTPS + JSON API, seega saab seda kasutada iga keel või tööriist, mis suudab veebipäringuid teha.

Uuri kõiki otspunkte, parameetreid ja skeeme interaktiivses OpenAPI viitedokumentatsioonis:

Baas-URL ja versioonimine

API on versioonitud. Kõik otspunktid asuvad prefiksi /api/v1 all, et tulevased muudatused ei lõhuks sinu integratsiooni.

Autentimine

Autendi iga päring API võtmega, mis saadetakse bearer tokenina:

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

Ära kunagi lisa API võtit kliendipoolsesse koodi ega avalikku repositooriumisse.

Millele sul on ligipääs

v1 API hõlmab peamisi värbamisobjekte:

• Kampaaniad — loetle ja ava rollid, millele inimesi värbad.
• Kandideerimised — loetle ja ava kandidaatide esitatud avaldused.
• Kasutajad — loetle ja ava oma tööruumi liikmed.

Vastused on JSON-vormingus ja sisaldavad välju, mida näed rakenduses, näiteks kampaania pealkiri ja olek või kandideerimise etapp ja keel.

Lehitsemine ja filtreerimine

Loendi otspunktid tagastavad tulemused lehtedena. Kasuta lehitsemise parameetreid, et liikuda läbi suurte tulemihulkade, ja filtreeri seal, kus see on toetatud, et tuua ainult vajalik.

Vead

API kasutab standardseid HTTP olekukoode — 2xx edu, 4xx sinu päringuga seotud probleemide (näiteks puuduva või kehtetu võtme) ja 5xx ootamatute serverivigade jaoks. Veavastused sisaldavad sõnumit, mis kirjeldab, mis valesti läks.

Seotud

• API võtmed
• Webhookid tõuketeavituste jaoks pollimise asemel