Tracking de l'activité par API

Vous pouvez également envoyer les informations de candidatures 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. Candidature

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

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

Headers

Name	Value
Content-Type	application/json
Authorization	x-api-key <api-key>

Body

Name	Type	Description
clickId	string - Required	Id de la redirection associée à la création de compte
missionId	string	Id de la mission pour laquelle une création de compte est identifié (Id fourni par l'API)
tag	string	Tag de la création de compte

Response

200

/** Call with the body set to
* missionId = "87654321-431-4321-210987654321"
* clickId = "12345678-1234-1234-1234-123456789012
*/
{
    "ok": true,
    "data": {
        "_id": "4504486e-e15b-486e-9d25-0740b8b69e34",
        "clikcId": "12345678-1234-1234-1234-123456789012",
        "missionId": "87654321-431-4321-210987654321",
        "missionClientId": "xxxxxx",
        "missionDomain": "education",
        "missionTitle": "Le titre de ma mission",
        "missionPostalCode": "33440",
        "missionDepartmentName": "Gironde",
        "missionOrganizationName": "Mon asso preferee",
        "missionOrganizationId": "xxxx",
        "toPublisherId": "xxxxx",
        "toPublisherName": "Mon compte partenaire",
        "fromPublisherId": "xxxxx",
        "fromPublisherName": "Mon partenaire diffuseur",
        "tag": "les-meilleurs-missions",
        "host": "https://xxx.yyy.fr",
        "created_at": "2024-03-13T13:00:00.000Z",
        "source": "publisher",
        "type": "apply",
        "status" : "PENDING",
    }
}

400

/** Call with the body set to
* missionId = "87654321-431-4321-210987654321"
*/
{
    "ok": false,
    "code": "INVALID_BODY",
    "error": {
        "issues": [
            {
                "code": "invalid_type",
                "expected": "string",
                "received": "undefined",
                "path": [
                    "clickId"
                ],
                "message": "Required"
            }
        ],
        "name": "ZodError"
    }
}

2. Création de compte

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

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

Headers

Name	Value
Content-Type	application/json
Authorization	x-api-key <api-key>

Body

Name	Type	Description
clickId	string - Required	Id de la redirection associée à la création de compte
missionId	string	Id de la mission pour laquelle une création de compte est identifié (Id fourni par l'API)
tag	string	Tag de la création de compte

Response

200

/** Call with the body set to
* missionId = "87654321-431-4321-210987654321"
* clickId = "12345678-1234-1234-1234-123456789012
*/
{
    "ok": true,
    "data": {
        "_id": "4504486e-e15b-486e-9d25-0740b8b69e34",
        "clikcId": "12345678-1234-1234-1234-123456789012",
        "missionId": "87654321-431-4321-210987654321",
        "missionClientId": "xxxxxx",
        "missionDomain": "education",
        "missionTitle": "Le titre de ma mission",
        "missionPostalCode": "33440",
        "missionDepartmentName": "Gironde",
        "missionOrganizationName": "Mon asso preferee",
        "missionOrganizationId": "xxxx",
        "toPublisherId": "xxxxx",
        "toPublisherName": "Mon compte partenaire",
        "fromPublisherId": "xxxxx",
        "fromPublisherName": "Mon partenaire diffuseur",
        "tag": "les-meilleurs-missions",
        "host": "https://xxx.yyy.fr",
        "created_at": "2024-03-13T13:00:00.000Z",
        "source": "publisher",
        "type": "account"
    }
}

400

/** Call with the body set to
* missionId = "87654321-431-4321-210987654321"
*/
{
    "ok": false,
    "code": "INVALID_BODY",
    "error": {
        "issues": [
            {
                "code": "invalid_type",
                "expected": "string",
                "received": "undefined",
                "path": [
                    "clickId"
                ],
                "message": "Required"
            }
        ],
        "name": "ZodError"
    }
}