Qualifier une candidature

Déclare ou met à jour une activité (impression, clic, candidature) associée à une mission.

Créer une activité

post

https://api.api-engagement.beta.gouv.frhttps://api.bac-a-sable.api-engagement.beta.gouv.frhttp://localhost:3002

/v2/activity

Enregistre un événement d'engagement (candidature ou création de compte) lié à un clic tracé par l'API ou directement à une mission.

Le "clickId" doit correspondre à un clic enregistré par l'API Engagement. Le "missionId" permet à un diffuseur autorisé de déclarer une activité sans clic. Le "missionClientId" correspond à l'identifiant métier d'une mission du publisher authentifié. Au moins un champ parmi "clickId", "missionId" et "missionClientId" doit être fourni. Le champ "missionId" ne doit pas être combiné avec "clickId" ou "missionClientId".

Authorizations

ApiKeyAuth

x-api-keystringRequired

Clé API fournie par l'équipe API Engagement

Body

application/json

anyOptional

or

anyOptional

or

anyOptional

Responses

200

Activité créée

application/json

okbooleanOptionalExample: true

400

Paramètres invalides

application/json

401

Clé API manquante ou invalide

application/json

403

Accès refusé

application/json

404

Clic ou mission introuvable

application/json

post/v2/activity

HTTPcURLJavaScriptPython

POST /v2/activity HTTP/1.1
Host: api.api-engagement.beta.gouv.fr
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 130

{
  "type": "apply",
  "clickId": "64a1b2c3d4e5f6789abc0088",
  "missionId": "64a1b2c3d4e5f6789abc0001",
  "missionClientId": "text",
  "tag": "text"
}

{
  "ok": true,
  "data": {
    "_id": "64a1b2c3d4e5f6789abc0099",
    "type": "apply",
    "status": "PENDING",
    "clickId": "64a1b2c3d4e5f6789abc0050",
    "missionClientId": "mission-bénévolat-2024-001",
    "missionId": "64a1b2c3d4e5f6789abc0001",
    "tag": "homepage",
    "createdAt": "2024-03-15T10:22:00.000Z"
  }
}

Mettre à jour le statut d'une activité

put

https://api.api-engagement.beta.gouv.frhttps://api.bac-a-sable.api-engagement.beta.gouv.frhttp://localhost:3002

/v2/activity/{id}

Met à jour le statut d'une candidature ou d'une création de compte. Utilisez ce endpoint pour notifier l'API des décisions prises sur les candidatures (validation, refus, annulation, etc.).

Authorizations

ApiKeyAuth

x-api-keystringRequired

Clé API fournie par l'équipe API Engagement

Path parameters

idstringRequired

Identifiant interne ou "clientEventId" de l'activité

Body

application/json

statusstring · enumRequired

Nouveau statut de l'activité

Example: VALIDATEDPossible values:

typestring · enumOptional

Type de l'activité (requis en cas d'ambiguïté)

Possible values:

Responses

200

Activité mise à jour

application/json

okbooleanOptionalExample: true

400

Paramètres invalides

application/json

401

Clé API manquante ou invalide

application/json

404

Ressource introuvable

application/json

409

Ambiguïté sur le clientEventId — précisez le paramètre "type"

application/json

put/v2/activity/{id}

HTTPcURLJavaScriptPython

PUT /v2/activity/{id} HTTP/1.1
Host: api.api-engagement.beta.gouv.fr
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "status": "VALIDATED",
  "type": "apply"
}

{
  "ok": true,
  "data": {
    "_id": "64a1b2c3d4e5f6789abc0099",
    "type": "apply",
    "status": "PENDING",
    "clickId": "64a1b2c3d4e5f6789abc0050",
    "missionClientId": "mission-bénévolat-2024-001",
    "missionId": "64a1b2c3d4e5f6789abc0001",
    "tag": "homepage",
    "createdAt": "2024-03-15T10:22:00.000Z"
  }
}