REST API

A PeekHire REST API lehetővé teszi, hogy a saját szoftvered a toborzási adataiddal dolgozzon. Ez egy szabványos HTTPS + JSON API, így bármilyen nyelv vagy eszköz használhatja, amely képes webes kéréseket indítani.

Fedezz fel minden végpontot, paramétert és sémát az interaktív OpenAPI referenciában:

Alap URL és verziókezelés

Az API verziózott. Minden végpont az /api/v1 előtag alatt található, így a jövőbeli változtatások nem törik el az integrációdat.

Hitelesítés

Hitelesíts minden kérést egy API key használatával, bearer tokenként elküldve:

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

Soha ne ágyazz be API key-t kliensoldali kódba vagy nyilvános repositoryba.

Mihez férhetsz hozzá

A v1 API a legfontosabb toborzási objektumokat fedi le:

• Kampányok — listázd és kérdezd le azokat a pozíciókat, amelyekre felvételt hirdetsz.
• Jelentkezések — listázd és kérdezd le a jelöltek jelentkezéseit.
• Felhasználók — listázd és kérdezd le a workspace tagjait.

A válaszok JSON formátumúak, és tartalmazzák az appban látható mezőket, például egy kampány címét és státuszát, vagy egy jelentkezés szakaszát és nyelvét.

Lapozás és szűrés

A lista végpontok oldalanként adják vissza az eredményeket. Használd a lapozási paramétereket a nagy eredményhalmazok bejárásához, és ahol támogatott, szűrj, hogy csak azt kérd le, amire szükséged van.

Hibák

Az API szabványos HTTP státuszkódokat használ — 2xx siker esetén, 4xx a kéréseddel kapcsolatos problémákra (például hiányzó vagy érvénytelen kulcs), és 5xx váratlan szerverhibákra. A hibaválaszok tartalmaznak egy üzenetet, amely leírja, mi történt.

Kapcsolódó anyagok

• API keys
• Webhooks push értesítésekhez polling helyett