REST API

PeekHire REST API antaa oman ohjelmistosi käyttää rekrytointitietojasi. Se on tavallinen HTTPS + JSON API, joten mikä tahansa kieli tai työkalu, joka voi tehdä verkkopyyntöjä, voi käyttää sitä.

Tutustu kaikkiin päätepisteisiin, parametreihin ja skeemoihin interaktiivisessa OpenAPI-viitteessä:

Perus-URL ja versiointi

API on versioitu. Kaikki päätepisteet ovat /api/v1-etuliitteen alla, jotta tulevat muutokset eivät riko integraatiotasi.

Todennus

Todenna jokainen pyyntö API-avaimella, joka lähetetään bearer-tunnuksena:

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

Älä koskaan upota API-avainta asiakaspuolen koodiin tai julkiseen repositorioon.

Mitä voit käyttää

v1 API kattaa keskeiset rekrytointiobjektit:

• Kampanjat — listaa ja hae roolit, joihin rekrytoit.
• Hakemukset — listaa ja hae ehdokkaiden lähettämät hakemukset.
• Käyttäjät — listaa ja hae työtilasi jäsenet.

Vastaukset ovat JSON-muotoisia ja sisältävät kentät, jotka näet sovelluksessa, kuten kampanjan otsikon ja tilan tai hakemuksen vaiheen ja kielen.

Sivutus ja suodatus

Listauspäätepisteet palauttavat tulokset sivuina. Käytä sivutusparametreja selataksesi suuria tulosjoukkoja ja suodata tuetuissa kohdissa, jotta haet vain tarvitsemasi.

Virheet

API käyttää standardeja HTTP-tilakoodeja — 2xx onnistumisille, 4xx pyynnön ongelmille (kuten puuttuva tai virheellinen avain) ja 5xx odottamattomille palvelinvirheille. Virhevastaukset sisältävät viestin, joka kuvaa, mikä meni pieleen.

Aiheeseen liittyvät

• API-avaimet
• Webhookit push-ilmoituksiin jatkuvan kyselyn sijaan