REST API

L'API REST di PeekHire consente al tuo software di lavorare con i tuoi dati di recruiting. È un'API standard HTTPS + JSON, quindi qualsiasi linguaggio o strumento in grado di effettuare richieste web può utilizzarla.

Esplora ogni endpoint, parametro e schema nel riferimento OpenAPI interattivo:

URL di base e versionamento

L'API è versionata. Tutti gli endpoint si trovano sotto il prefisso /api/v1, così le modifiche future non interromperanno la tua integrazione.

Autenticazione

Autentica ogni richiesta con una chiave API inviata come bearer token:

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

Non incorporare mai una chiave API nel codice lato client o in un repository pubblico.

A cosa puoi accedere

L'API v1 copre gli oggetti principali del recruiting:

• Campagne — elenca e recupera i ruoli per cui stai assumendo.
• Candidature — elenca e recupera le candidature inviate dai candidati.
• Utenti — elenca e recupera i membri del tuo workspace.

Le risposte sono in JSON e includono i campi che vedi nell'app, come il titolo e lo stato di una campagna o la fase e la lingua di una candidatura.

Paginazione e filtri

Gli endpoint di elenco restituiscono i risultati in pagine. Usa i parametri di paginazione per scorrere set di risultati di grandi dimensioni e, dove supportato, applica filtri per recuperare solo ciò che ti serve.

Errori

L'API usa codici di stato HTTP standard: 2xx per il successo, 4xx per problemi con la tua richiesta (come una chiave mancante o non valida) e 5xx per errori imprevisti del server. Le risposte di errore includono un messaggio che descrive cosa è andato storto.

Risorse correlate

• Chiavi API
• Webhook per notifiche push invece del polling