API pour partenaires ATS

Cette API permet aux partenaires ATS (Applicant Tracking Systems) d'intégrer Omogen comme service tiers pour gérer les entretiens de préqualification et de réactivation de leurs candidats. Elle fournit des endpoints pour synchroniser les offres d'emploi, créer des processus d'entretien, et des webhooks pour recevoir les rapports d'évaluation.

Télécharger la spec OpenAPI

Cette page est générée depuis une spec OpenAPI 3.0 disponible au téléchargement : 📄 JSON · 📄 YAML

Omogen automatise les entretiens téléphoniques avec les candidats via son agent conversationnel Alex, évalue leur adéquation avec les critères de sélection et génère des rapports détaillés pour aider les recruteurs dans leur prise de décision.

API en cours de construction

N'hésitez pas à contacter le support si besoin : gillian@omogen.ai.

Authentification

L'authentification se fait via deux clés distinctes :

1. Une clé API Omogen transmise dans le header Authorization avec le format Bearer token
2. Une clé partenaire transmise dans le header OM-PARTNER pour identifier le partenaire ATS

Headers requis

Authorization: Bearer <API_KEY>
OM-PARTNER: <PARTNER_KEY>

Exemple

curl -X GET https://api.omogen.ai/api/v1/integration-partner/interview-params \
  -H "Authorization: Bearer sk_partner_abc123xyz..." \
  -H "OM-PARTNER: partner_xyz" \
  -H "Content-Type: application/json"

Gestion des clés

Les clés API sont générées et gérées par l'équipe Omogen. Chaque clé est liée à une organisation spécifique.

• Clé partenaire : Chaque partenaire ATS dispose d'une clé partenaire unique qui permet d'identifier l'origine des requêtes. Cette clé est fournie lors de la configuration de l'intégration.
• Clé API : Pour obtenir la clé API d'une organisation, contactez l'équipe support à support@omogen.ai.

Flows d'intégration

Omogen propose deux modes d'intégration pour synchroniser les offres d'emploi. Le choix du flow se configure dans les settings d'intégration de l'application Omogen.

Comparatif des deux flows

Aspect	Flow 1 : Push	Flow 2 : Pull
Qui synchronise les jobs ?	Le partenaire ATS envoie les jobs à Omogen	Omogen récupère les jobs depuis l'ATS
Complexité côté partenaire	Faible (appels API sortants uniquement)	Moyenne (endpoint à implémenter)
Pré-requis	Aucun endpoint à développer	Endpoint de lecture des jobs requis
Configuration Omogen	Clés API uniquement	Clés API + URL endpoint + credentials partenaire

Flow 1 : Push (synchronisation par le partenaire)

Le partenaire ATS synchronise les offres d'emploi avant d'envoyer les candidatures.

Flow 2 : Pull (récupération par Omogen)

Le partenaire envoie directement les candidatures. Omogen récupère automatiquement les informations de l'offre d'emploi via un endpoint exposé par le partenaire.

Configuration du Flow 2 dans Omogen

Pour activer le Flow 2 (Pull), configurez les paramètres suivants dans les settings d'intégration de l'application Omogen :

Paramètre	Description
job_fetch_url	URL template de l'endpoint partenaire. Doit contenir le placeholder {job_id}, qu'Omogen remplace par l'external_job_id au moment de l'appel (ex : https://api.partner.com/v1/jobs/{job_id})
job_fetch_headers	Headers statiques injectés sur chaque requête (ex : {"Authorization": "Bearer <partner_api_key>"}). Utilisé pour l'authentification standard côté partenaire.
job_fetch_secret	Secret partagé utilisé pour signer chaque requête en HMAC-SHA256 (optionnel mais recommandé). Voir la section « Signature des requêtes » ci-dessous.

Endpoint à implémenter (Flow 2)

Endpoint : GET <job_fetch_url> où le placeholder {job_id} est remplacé par l'external_job_id envoyé dans POST /applications.

Headers envoyés par Omogen :

<headers configurés dans job_fetch_headers>
Content-Type: application/json
OM-OMOGEN-TIMESTAMP: <unix_timestamp>
OM-OMOGEN-REQUEST: <hmac_sha256_signature>

Signature des requêtes (recommandé)

Lorsque job_fetch_secret est configuré, Omogen signe chaque requête afin que le partenaire puisse vérifier l'origine de l'appel. Le partenaire doit recomposer la même signature de son côté et la comparer au header OM-OMOGEN-REQUEST.

timestamp = str(int(unix_time_seconds))
payload   = f"{timestamp}.{external_job_id}"
signature = HMAC_SHA256(secret=job_fetch_secret, message=payload).hexdigest()

Anti-rejeu

Le timestamp est en secondes Unix. Il est recommandé de rejeter les requêtes dont le timestamp s'écarte de plus de 5 minutes de l'heure serveur du partenaire afin de limiter les attaques par rejeu.

Réponse attendue (200 OK)

{
  "job_title": "Développeur Full Stack Python/React",
  "job_description": "Nous recherchons un développeur full stack expérimenté...",
  "metadata": {
    "department": "Engineering",
    "location": "Paris",
    "contract_type": "CDI"
  }
}

Champ	Type	Requis	Description
job_title	string	✅	Titre du poste
job_description	string	✅	Description complète du poste (min. 100 caractères recommandé)
metadata	object	❌	Champs additionnels libres (stockés comme metadata dans Omogen)

Codes d'erreur attendus côté partenaire

Code partenaire	Description	Code Omogen renvoyé au partenaire
200	Succès	Création/mise à jour de la job
404	Job non trouvée	400 JOB_FETCH_NOT_FOUND
4xx/5xx	Erreur serveur partenaire	502 JOB_FETCH_HTTP_ERROR
timeout/réseau	Erreur réseau	502 JOB_FETCH_NETWORK_ERROR
JSON invalide	Réponse non parsable	502 JOB_FETCH_INVALID_RESPONSE
200 sans job_title	Champ obligatoire manquant	502 JOB_FETCH_MISSING_TITLE

Référence des endpoints

La section suivante est générée automatiquement à partir de la spécification OpenAPI openapi-partenaires.yaml.

Get Interview Params

Get Interview Params

GET

/interview-params

Récupère les paramètres de configuration disponibles pour les entretiens.
Permet aux utilisateurs de choisir d'activer Omogen et de sélectionner un mode de déploiement.

⚠️ Les paramètres exacts peuvent être personnalisés pour améliorer l'expérience utilisateur dans l'ATS.

Authorizations

BearerToken

Clé API Omogen envoyée dans le header Authorization: Bearer <API_KEY>. Fournie par le support Omogen.

Type

HTTP (bearer)

+

OmPartner

Clé partenaire unique envoyée dans le header OM-PARTNER: <PARTNER_KEY>. Identifie l'ATS source.

Type

API Key (header: OM-PARTNER)

Parameters

Query Parameters

lang

Code langue des libellés retournés

Type

string

Valid values

"fr""en"

Default

"fr"

Responses

Paramètres récupérés avec succès

Content-Type

application/json

{

  

"success": true,

  

"data": {

  

  

"use_cases": [

  

  

  

{

  

  

  

  

"value": "string",

  

  

  

  

"label": "string"

  

  

  

}

  

  

],

  

  

"deployment_templates": [

  

  

  

{

  

  

  

  

"value": "string",

  

  

  

  

"label": "string",

  

  

  

  

"description": "string"

  

  

  

}

  

  

],

  

  

"report_limit": {

  

  

  

"default": 0,

  

  

  

"min": 0,

  

  

  

"max": 0,

  

  

  

"label": "string",

  

  

  

"description": "string"

  

  

},

  

  

"match_limit": {

  

  

  

"default": 0,

  

  

  

"min": 0,

  

  

  

"max": 0,

  

  

  

"label": "string",

  

  

  

"description": "string"

  

  

}

  

}

}

Sync a Job Offer

Sync a Job Offer

POST

/jobs

Synchronise une offre d'emploi dans Omogen. Le endpoint retourne immédiatement
(201 Created) avec l'id de la job et un edit_url. L'extraction des critères
de sélection et la génération du plan d'entretien se font de manière asynchrone
en arrière-plan.

ℹ️ Cet endpoint est utilisé uniquement dans le Flow 1 (Push). Dans le Flow 2,
les jobs sont créées automatiquement lors de la réception d'une candidature.

Idempotence : si external_job_id est fourni et qu'une job avec cet identifiant
existe déjà pour l'organisation, l'endpoint retourne 200 OK au lieu de 201 et
ne recrée pas la job.

Authorizations

BearerToken

Clé API Omogen envoyée dans le header Authorization: Bearer <API_KEY>. Fournie par le support Omogen.

Type

HTTP (bearer)

+

OmPartner

Clé partenaire unique envoyée dans le header OM-PARTNER: <PARTNER_KEY>. Identifie l'ATS source.

Type

API Key (header: OM-PARTNER)

Request Body

application/json

{

  

"job_title": "string",

  

"job_description": "string",

  

"external_job_id": "string"

}

Responses

Job déjà existante (idempotence sur external_job_id)

Content-Type

application/json

{

  

"success": true,

  

"message": "string",

  

"data": {

  

  

"job_opportunity_id": "string",

  

  

"edit_url": "string"

  

}

}

Sync an Application

Sync an Application (Create Interview Process)

POST

/applications

Crée ou met à jour un candidat et crée un processus d'entretien (process) pour celui-ci.
Le candidat sera contacté selon le mode de déploiement spécifié.

Comportement selon le flow

• Flow 1 (Push) : l'external_job_id doit correspondre à une job déjà synchronisée via POST /jobs.
• Flow 2 (Pull) : Omogen récupère automatiquement les infos de l'offre via l'endpoint du partenaire.
• Mode triage : si aucun external_job_id n'est fourni et que le mode triage est activé, Omogen
  utilise le CV pour déterminer automatiquement la job cible.

Pour un appel à cet endpoint qui n'inclut que le CV (sans données candidat),
utiliser plutôt POST /applications/cv-only.

Authorizations

BearerToken

Clé API Omogen envoyée dans le header Authorization: Bearer <API_KEY>. Fournie par le support Omogen.

Type

HTTP (bearer)

+

OmPartner

Clé partenaire unique envoyée dans le header OM-PARTNER: <PARTNER_KEY>. Identifie l'ATS source.

Type

API Key (header: OM-PARTNER)

Request Body

application/json

{

  

"external_application_id": "string",

  

"external_job_id": "string",

  

"external_candidate_id": "string",

  

"first_name": "string",

  

"last_name": "string",

  

"email": "string",

  

"phone": "string",

  

"use_case": "prequalification",

  

"deployment_template": "string",

  

"cv_url": "string",

  

"job_title": "string",

  

"job_description": "string"

}

Responses

Application déjà existante (idempotence)

Content-Type

application/json

{

  

"success": true,

  

"message": "string",

  

"data": {

  

  

"process_id": "string",

  

  

"status": "string"

  

}

}

Sync a CV-only Application

Sync an Application from CV only

POST

/applications/cv-only

Crée un processus d'entretien à partir d'un CV seul. Omogen extrait automatiquement
les informations candidat (nom, prénom, email, téléphone) depuis le CV via un service
d'extraction. Si l'extraction échoue pour certains champs, les valeurs de secours
fournies dans la requête sont utilisées.

Format de la requête : multipart/form-data ou application/json.
Le CV peut être fourni soit en base64 via cv_file, soit via une URL publique via
cv_url. L'un des deux est obligatoire.

Extensions supportées : .pdf, .doc, .docx, .txt, .rtf.

Authorizations

BearerToken

Clé API Omogen envoyée dans le header Authorization: Bearer <API_KEY>. Fournie par le support Omogen.

Type

HTTP (bearer)

+

OmPartner

Clé partenaire unique envoyée dans le header OM-PARTNER: <PARTNER_KEY>. Identifie l'ATS source.

Type

API Key (header: OM-PARTNER)

Request Body

object

Contenu du CV encodé en base64. Exclusif avec cv_url — au moins l'un des deux est requis.

Format"byte"

URL publique vers le CV. Exclusif avec cv_file — au moins l'un des deux est requis.

Format"uri"

Nom du fichier avec extension (.pdf, .doc, .docx, .txt, .rtf)

Prénom de secours si l'extraction depuis le CV échoue

Nom de secours si l'extraction depuis le CV échoue

Email de secours si l'extraction depuis le CV échoue

Format"email"

Téléphone de secours si l'extraction depuis le CV échoue

ID de l'offre dans le système partenaire. Optionnel si mode triage.

Valid values"prequalification""reactivation"

Default"prequalification"

Responses

Application déjà existante (idempotence)

Content-Type

application/json

{

  

"success": true,

  

"message": "string",

  

"data": {

  

  

"process_id": "string",

  

  

"status": "string"

  

}

}