REST API
The PeekHire REST API umožňuje vášmu vlastnému softvéru pracovať s vašimi náborovými dátami. Je to štandardné HTTPS + JSON API, takže ho môže používať akýkoľvek jazyk alebo nástroj, ktorý vie odosielať webové požiadavky.
Preskúmajte každý endpoint, parameter a schému v interaktívnej referencii OpenAPI:
Otvoriť referenciu APIZákladná URL a verzovanie
API je verzované. Všetky endpointy sa nachádzajú pod prefixom /api/v1, takže budúce
zmeny nenarušia vašu integráciu.
Autentifikácia
Každú požiadavku autentifikujte pomocou API kľúča odoslaného ako bearer token:
curl https://your-api-host/api/v1/campaigns \
-H "Authorization: Bearer YOUR_API_KEY"
Nikdy nevkladajte API kľúč do kódu na strane klienta ani do verejného repozitára.
K čomu máte prístup
API v1 pokrýva hlavné náborové objekty:
- Kampane — zobrazujte zoznam a detail pozícií, na ktoré naberáte.
- Žiadosti — zobrazujte zoznam a detail prihlášok kandidátov.
- Používatelia — zobrazujte zoznam a detail členov vášho pracovného priestoru.
Odpovede sú vo formáte JSON a obsahujú polia, ktoré vidíte v aplikácii, napríklad názov a stav kampane alebo fázu a jazyk žiadosti.
Stránkovanie a filtrovanie
Endpointy so zoznamami vracajú výsledky po stránkach. Pomocou parametrov stránkovania môžete prechádzať veľké množiny výsledkov a tam, kde je to podporované, filtrovať iba to, čo potrebujete.
Chyby
API používa štandardné stavové kódy HTTP — 2xx pre úspech, 4xx pre problémy
s vašou požiadavkou (napríklad chýbajúci alebo neplatný kľúč) a 5xx pre neočakávané
chyby servera. Chybové odpovede obsahujú správu s popisom toho, čo sa pokazilo.