Tracking de l'activité par API

Vous pouvez également envoyer les informations de candidatures ou de création de compte manuellement, en suivant le ce guide :

Redirection

Les redirections provenant de l'API contiennent un attribut unique dans les paramètres de requête, apiengagement_id. Cet attribut correspond à l'identifiant de la redirection qui a amené l'utilisateur sur votre site. Exemple de lien suite à une redirection:

https://www.jeveuxaider.gouv.fr/?apiengagement_id=60a8e60ef959740741fa6616

Le tag de l'API Engagement permet de récupérer cette valeur et de la stocker dans les cookies sous le nom apiengagement. Cependant, si vous n'intégrez pas le script, il est important de récupérer cette valeur et de l'utiliser pour suivre une candidature ou une création de compte. Cela peut se faire en utilisant le localStorage, par exemple.

1. Créer une candidature ou une création de compte

POST https://api.api-engagement.beta.gouv.fr/v2/activity

Lorsqu'une candidature ou une création de compte est détectée chez vous, cette route permet de traquer celle ci dans la statistique de l'API Engagement.

Headers

Name	Type	Description
x-api-key Requis	string	La clé API nécessaire à l’authentification. Les données disponibles sont définies en fonction de votre clé API.

Body

Name	Type	Description
clickId	string - Required	Id de la redirection associée à la création de compte correspondant à la valeur comprise dans apiengagement_id
type	apply ou account	Type de l'activité à enregistrer: apply pour une candidature, account pour une création de compte. Défaut a apply
missionClientId	string	Id de la mission pour laquelle une création de compte est identifié (correspondant aux clientId dans le flux XML)
tag	string	Tag de la création de compte

Response

200

/** Call with the body set to
* missionClientId = "4321"
* clickId = "click_id"
* tag = "les-meilleurs-missions"
* type = "account"
*/
{
    "ok": true,
    "data": {
        "_id": "activity_id",
        "clikcId": "click_id",
        "missionId": "87654321-431-4321-210987654321",
        "missionClientId": "4321",
        "missionDomain": "education",
        "missionTitle": "Le titre de ma mission",
        "missionPostalCode": "33440",
        "missionDepartmentName": "Gironde",
        "missionOrganizationName": "Mon asso preferee",
        "missionOrganizationId": "xxxx",
        "toPublisherId": "mon_identifiant",
        "fromPublisherId": "identifiant_parteanire",
        "tag": "les-meilleurs-missions",
        "host": "https://xxx.yyy.fr",
        "created_at": "2024-03-13T13:00:00.000Z",
        "source": "publisher",
        "type": "account",
        "status" : "PENDING",
    }
}

400

404

2. Mettre à jour le status de la candidature

PUT https://api.api-engagement.beta.gouv.fr/v2/activity/:id

Il est possible de mettre à jour le statut d'une candidature ou d'une création de compte afin de suivre l'avancement du candidat

Headers

Name	Type	Description
x-api-key Requis	string	La clé API nécessaire à l’authentification. Les données disponibles sont définies en fonction de votre clé API.

Params

Name	Value
:id	Identifiant de la candidature ou de création de compte

Body

Name	Type	Description
status	PENDING, VALIDATED, CANCELED, REFUSED ou CARRIED_OUT	Statut de la candidature ou création du compte. Défaut à PENDING

Response

200

/** Call with the body set to
* status = "VALIDATED"
*/
{
    "ok": true,
    "data": {
        "_id": "activity_id",
        "clikcId": "click_id",
        "missionId": "87654321-431-4321-210987654321",
        "missionClientId": "4321",
        "missionDomain": "education",
        "missionTitle": "Le titre de ma mission",
        "missionPostalCode": "33440",
        "missionDepartmentName": "Gironde",
        "missionOrganizationName": "Mon asso preferee",
        "missionOrganizationId": "xxxx",
        "toPublisherId": "mon_identifiant",
        "fromPublisherId": "identifiant_parteanire",
        "tag": "les-meilleurs-missions",
        "host": "https://xxx.yyy.fr",
        "created_at": "2024-03-13T13:00:00.000Z",
        "source": "publisher",
        "type": "account",
        "status" : "VALIDATED",
    }
}

400

404