Aller au contenu principal

API publique recruteur

Intégrez Kreol Job dans votre ATS, votre site carrière ou vos automatisations. Gérez vos offres, suivez vos candidatures et exportez vos stats via une API REST avec clés Bearer.

Gérer mes clés APISpec OpenAPI JSON

Authentification

Toutes les requêtes nécessitent un header Authorization: Bearer kj_live_xxxxx. Génère une clé depuis ton espace recruteur, puis stocke-la côté serveur (jamais en clair côté frontend).

Exemple curl :

curl https://kreol-job.re/api/v1/offres \
  -H "Authorization: Bearer kj_live_xxxxx"

Rate limit & quotas

  • 1000 requêtes par heure et par clé
  • Réponse 429 + header Retry-After quand la limite est atteinte
  • Headers de quota inclus dans chaque réponse : X-RateLimit-Limit/Remaining/Reset

Scopes

Chaque clé est limitée aux scopes choisis à la création.

  • read:offres — Lecture des offres
  • write:offres — Création / mise à jour / suppression
  • read:candidatures — Lecture des candidatures reçues
  • write:candidatures — Changement de statut / note
  • read:stats — Statistiques agrégées

Endpoints

/api/v1/offres
getListe mes offresread:offres

Retourne les offres dont je suis propriétaire (recruteurId = clé.userId).

Paramètres : page (query), limit (query), publie (query)
postCrée une offrewrite:offres

L'offre est créée avec publie=false jusqu'à modération manuelle par un admin.

/api/v1/offres/{id}
getLit une offreread:offres
Paramètres : id (path, requis)
patchModifie une offrewrite:offres
Paramètres : id (path, requis)
deleteSupprime une offrewrite:offres
Paramètres : id (path, requis)
/api/v1/candidatures
getListe les candidatures reçuesread:candidatures

Liste les candidatures pour mes offres. Les candidats en mode anonyme ont leurs identifiants masqués (anonyme: true).

Paramètres : offreId (query), statut (query), page (query), limit (query)
/api/v1/candidatures/{id}
getLit une candidatureread:candidatures
Paramètres : id (path, requis)
patchMet à jour le statut ou la notewrite:candidatures
Paramètres : id (path, requis)
/api/v1/stats
getStatistiques globalesread:stats