API REST
L’API REST de PeekHire permet à ton propre logiciel de travailler avec tes données de recrutement. C’est une API HTTPS + JSON standard, donc tout langage ou outil capable d’effectuer des requêtes web peut l’utiliser.
Explore chaque point de terminaison, paramètre et schéma dans la référence OpenAPI interactive :
Ouvrir la référence de l'APIURL de base et versionnement
L’API est versionnée. Tous les points de terminaison se trouvent sous le préfixe /api/v1
afin que les changements futurs ne cassent pas ton intégration.
Authentification
Authentifie chaque requête avec une clé API envoyée comme jeton bearer :
curl https://your-api-host/api/v1/campaigns \
-H "Authorization: Bearer YOUR_API_KEY"
N’intègre jamais une clé API dans du code côté client ou dans un dépôt public.
Ce à quoi tu peux accéder
L’API v1 couvre les principaux objets de recrutement :
- Campagnes — lister et récupérer les postes pour lesquels tu recrutes.
- Candidatures — lister et récupérer les candidatures.
- Utilisateurs — lister et récupérer les membres de ton espace de travail.
Les réponses sont en JSON et incluent les champs que tu vois dans l’application, comme le titre et le statut d’une campagne, ou l’étape et la langue d’une candidature.
Pagination et filtrage
Les points de terminaison de liste renvoient les résultats par pages. Utilise les paramètres de pagination pour parcourir les grands ensembles de résultats, et filtre quand c’est pris en charge afin de récupérer uniquement ce dont tu as besoin.
Erreurs
L’API utilise les codes de statut HTTP standard : 2xx pour les succès, 4xx pour les problèmes
liés à ta requête (comme une clé manquante ou invalide) et 5xx pour les erreurs serveur
inattendues. Les réponses d’erreur incluent un message décrivant ce qui s’est passé.