REST API

API REST PeekHire permite propriului tău software să lucreze cu datele tale de recrutare. Este un API standard HTTPS + JSON, astfel că orice limbaj sau instrument care poate face solicitări web îl poate folosi.

Explorează fiecare endpoint, parametru și schemă în referința interactivă OpenAPI:

URL de bază și versiuni

API este versionat. Toate endpointurile se află sub prefixul /api/v1, astfel încât modificările viitoare să nu îți afecteze integrarea.

Autentificare

Autentifică fiecare solicitare cu o cheie API trimisă ca token bearer:

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

Nu include niciodată o cheie API în cod client-side sau într-un repository public.

Ce poți accesa

API v1 acoperă obiectele principale de recrutare:

• Campanii — listează și recuperează rolurile pentru care recrutezi.
• Aplicații — listează și recuperează candidaturile trimise de candidați.
• Utilizatori — listează și recuperează membrii workspace-ului tău.

Răspunsurile sunt în JSON și includ câmpurile pe care le vezi în aplicație, cum ar fi titlul și statusul unei campanii sau etapa și limba unei candidaturi.

Paginare și filtrare

Endpointurile de listare returnează rezultatele în pagini. Folosește parametrii de paginare pentru a parcurge seturi mari de rezultate și filtrează acolo unde este posibil pentru a prelua doar ce ai nevoie.

Erori

API folosește coduri de status HTTP standard — 2xx pentru succes, 4xx pentru probleme cu solicitarea ta (cum ar fi o cheie lipsă sau invalidă) și 5xx pentru erori neașteptate de server. Răspunsurile de eroare includ un mesaj care descrie ce nu a mers bine.

Resurse conexe

• Chei API
• Webhooks pentru notificări push în loc de polling