PeekHire logotipas
Automatizavimas ir programuotojai

REST API

Programiškai skaitykite ir valdykite kampanijas, paraiškas ir naudotojus.

PeekHire REST API leidžia jūsų programinei įrangai dirbti su jūsų atrankų duomenimis. Tai standartinė HTTPS + JSON API, todėl ja gali naudotis bet kuri kalba ar įrankis, galintis siųsti žiniatinklio užklausas.

Naršykite visus endpointus, parametrus ir schemas interaktyvioje OpenAPI nuorodoje:

Atidaryti API žinyną

Bazinis URL ir versijų valdymas

API turi versijas. Visi endpointai yra po /api/v1 prefiksu, kad būsimi pakeitimai nesugadintų jūsų integracijos.

Autentifikavimas

Autentifikuokite kiekvieną užklausą su API raktu, siunčiamu kaip bearer tokenas:

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

Niekada neįterpkite API rakto į kliento pusės kodą ar viešą saugyklą.

Ką galite pasiekti

v1 API apima pagrindinius atrankų objektus:

  • Kampanijos — peržiūrėkite sąrašą ir gaukite pozicijas, į kurias samdote.
  • Paraiškos — peržiūrėkite sąrašą ir gaukite kandidatų pateiktas paraiškas.
  • Naudotojai — peržiūrėkite sąrašą ir gaukite savo darbo srities narius.

Atsakymai pateikiami JSON formatu ir apima laukus, kuriuos matote programoje, pvz., kampanijos pavadinimą ir būseną arba paraiškos etapą ir kalbą.

Puslapiavimas ir filtravimas

Sąrašo endpointai grąžina rezultatus puslapiais. Naudokite puslapiavimo parametrus, kad pereitumėte per didelius rezultatų rinkinius, ir, kur palaikoma, filtruokite, kad gautumėte tik tai, ko reikia.

Klaidos

API naudoja standartinius HTTP būsenos kodus — 2xx sėkmei, 4xx problemoms su jūsų užklausa (pvz., kai trūksta rakto arba jis neteisingas) ir 5xx netikėtoms serverio klaidoms. Klaidų atsakymuose pateikiamas pranešimas, apibūdinantis, kas nutiko.

Susiję

Apžvalga

Automatizuokite PeekHire naudodami API, webhook’us, be programavimo įrankius arba dirbtinio intelekto asistentą.

API raktai

Kurkite, apribokite pagal teises ir keiskite raktus, kuriais autentifikuojama API prieiga.