Intégration de l'API Candidate Intelligence

Idéal pour

Avantages partenaire

Pourquoi intégrer Candidate Intelligence ?

Offrez à vos clients un contexte supplémentaire avant les entretiens tout en créant de la valeur au sein de votre plateforme.

Parcours d'intégration

Performances et latence

Candidate Intelligence est conçu pour offrir une expérience réactive directement dans les flux de travail des recruteurs.

Logique de réutilisation des rapports

Les rapports sont identifiés de façon unique par plateforme + entreprise + candidat.

Authentification

X-API-Key: ats_your_api_key_here
Content-Type: application/json

Créer une analyse

{
  "language": "en",
  "client": {
    "id": "client_company_123",
    "first_name": "Jane",
    "last_name": "Smith",
    "company": "Acme Recruiting"
  },
  "candidate": {
    "id": "candidate_456",
    "first_name": "John",
    "last_name": "Doe",
    "company": "Example Company",
    "location": "London, UK",
    "role": "Software Engineer",
    "cv": "Optional plain-text CV content…"
  }
}

202 Accepted

L'en-tête Location pointe vers GET /api/v1/analyses/'{'id'}'. Retry-After: 10 indique quand effectuer le prochain polling.

{
  "id": "cmqp23kgg00067gk0rh6jol5o",
  "status": "queued",
  "candidate_id": "candidate_456",
  "created_at": "2026-06-29T12:00:00.000Z"
}

Polling et résultats progressifs

Après un POST renvoyant 202 Accepted, interrogez GET /api/v1/analyses/'{'id'}' avec le même en-tête X-API-Key. Utilisez l'id de la réponse de création.

Tant que le statut est queued ou processing, chaque réponse GET inclut Retry-After: 10 — attendez au moins 10 secondes avant la requête suivante.

Arrêtez le polling lorsque le statut est completed, failed ou canceled.

{
  "id": "cmqp23kgg00067gk0rh6jol5o",
  "status": "processing",
  "candidate_id": "candidate_456",
  "stage": "enrichment",
  "created_at": "2026-06-29T12:00:00.000Z",
  "updated_at": "2026-06-29T12:00:20.000Z",
  "quick_signal": {
    "level": "Green",
    "reason": "Identity supported by multiple matching signals.",
    "identityConfidence": "Medium"
  },
  "signals": [
    {
      "statement": "Senior engineer at Example Company since 2021.",
      "sourceType": "web",
      "sourceUrl": "https://example.com/…",
      "reliability": "High"
    }
  ],
  "report": null,
  "metadata": null,
  "error": null
}

Champs renseignés pendant le traitement

Valeurs de statut

Annuler une analyse

DELETE /api/v1/analyses/'{'id'}' arrête une analyse en file d'attente ou en cours lorsqu'un recruteur quitte le profil candidat ou ferme un rapport en génération. Utilisez le même en-tête X-API-Key que pour POST et GET.

Si l'analyse est déjà completed, failed ou canceled, l'endpoint renvoie la ressource actuelle sans modification — aucun frais supplémentaire ni effet de bord.

// Aucun corps de requête — en-tête X-API-Key uniquement

200 OK

Renvoie la ressource d'analyse avec le statut canceled. Des quick_signal ou signals partiels peuvent être présents si l'annulation a eu lieu en cours de pipeline. Arrêtez le polling dès que le statut est canceled.

{
  "id": "cmqp23kgg00067gk0rh6jol5o",
  "status": "canceled",
  "candidate_id": "candidate_456",
  "stage": "enrichment",
  "created_at": "2026-06-29T12:00:00.000Z",
  "updated_at": "2026-06-29T12:00:25.000Z",
  "quick_signal": null,
  "signals": [],
  "report": null,
  "metadata": null,
  "error": null
}

Analyse terminée

Retournée lorsque le statut est completed.

{
  "id": "clx_analysis_id",
  "status": "completed",
  "candidate_id": "candidate_456",
  "stage": "done",
  "created_at": "2026-06-29T12:00:00.000Z",
  "updated_at": "2026-06-29T12:00:45.000Z",
  "quick_signal": {
    "level": "Green",
    "reason": "Identity supported by multiple matching signals.",
    "identityConfidence": "Medium"
  },
  "signals": [
    {
      "statement": "…",
      "sourceType": "web",
      "reliability": "High"
    }
  ],
  "report": {
    "candidateName": "John Doe",
    "recommendation": {
      "decision": "GO with validation",
      "confidence": "Medium",
      "reason": "…",
      "evidence": ["…"]
    },
    "summary": "…",
    "whatToValidate": ["…"]
  },
  "metadata": {
    "report_id": "clx_analysis_id",
    "candidate_id": "candidate_456",
    "language": "en",
    "generated_at": "2026-06-29T12:00:45.000Z",
    "pdf_download_url": "https://intelligence.tietalent.com/api/ats/reports/{id}/pdf?sig=…"
  },
  "error": null
}

Interface partenaire recommandée

Ajouter un bouton dans les profils candidats

Ajoutez un bouton « Lancer le rapport Candidate Intelligence » dans les profils candidats. Au clic, il devient « Génération du rapport en cours... » pendant la génération. Une fois prêt, le rapport s'ouvre automatiquement et le bouton devient « ✕ Fermer le rapport ». À la fermeture, il repasse à « Voir le rapport Intelligence » pour rouvrir un rapport déjà enregistré — sans rappeler POST.

Confidentialité et sécurité