# Documentation API Engagement

## Documentation Produit

- [Qu'est ce que l'API Engagement ?](https://doc.api-engagement.beta.gouv.fr/introduction/quest-ce-que-lapi-engagement.md)
- [À qui s'adresse l'API Engagement ?](https://doc.api-engagement.beta.gouv.fr/introduction/a-qui-sadresse-lapi-engagement.md): Définition des termes "Annonceur" et "Diffuseur"
- [Comment devenir partenaire ?](https://doc.api-engagement.beta.gouv.fr/introduction/comment-devenir-partenaire.md)
- [Les étapes à suivre pour partager des missions d'engagement à l'API Engagement](https://doc.api-engagement.beta.gouv.fr/annoncer-des-missions/les-etapes-a-suivre-pour-partager-des-missions-dengagement-a-lapi-engagement.md)
- [Étape 1 : mettre ses missions à disposition de l'API Engagement](https://doc.api-engagement.beta.gouv.fr/annoncer-des-missions/creation-dun-flux-xml.md): Cette partie de la documentation est à destination de votre responsable informatique : elle présente les critères nécessaires pour créer votre flux XML ou partager des missions par API
- [Méthode 1 : création d'un flux XML](https://doc.api-engagement.beta.gouv.fr/annoncer-des-missions/creation-dun-flux-xml/methode-1-creation-dun-flux-xml.md): Cette partie de la documentation est à destination de votre responsable informatique : elle présente les critères nécessaires pour créer votre flux XML, c’est-à-dire l’envoi d’informations vers l’API
- [Format du flux XML](https://doc.api-engagement.beta.gouv.fr/annoncer-des-missions/creation-dun-flux-xml/methode-1-creation-dun-flux-xml/format-du-flux-xml.md)
- [Liste des champs à inclure dans le flux XML](https://doc.api-engagement.beta.gouv.fr/annoncer-des-missions/creation-dun-flux-xml/methode-1-creation-dun-flux-xml/liste-des-champs-a-inclure-dans-le-flux-xml.md)
- [Dépreciée - Liste des champs à inclure dans le flux XML](https://doc.api-engagement.beta.gouv.fr/annoncer-des-missions/creation-dun-flux-xml/methode-1-creation-dun-flux-xml/depreciee-liste-des-champs-a-inclure-dans-le-flux-xml.md)
- [Conditions d'utilisation du flux XML](https://doc.api-engagement.beta.gouv.fr/annoncer-des-missions/creation-dun-flux-xml/methode-1-creation-dun-flux-xml/conditions-dutilisation-du-flux-xml.md)
- [Méthode 2 : création de missions par API](https://doc.api-engagement.beta.gouv.fr/annoncer-des-missions/creation-dun-flux-xml/methode-2-creation-de-missions-par-api.md): Cette partie de la documentation est à destination de votre responsable informatique : elle redirige vers la documentation technique de l'API permettant de créer, modifier et supprimer des missions.
- [Étape 2 : Mettre en place le suivi des candidatures](https://doc.api-engagement.beta.gouv.fr/annoncer-des-missions/tracking-des-candidatures.md)
- [Quelles sont les étapes du parcours de l'engagement que l'API Engagement traque ?](https://doc.api-engagement.beta.gouv.fr/annoncer-des-missions/tracking-des-candidatures/quelles-sont-les-etapes-du-parcours-de-lengagement-que-lapi-engagement-traque.md)
- [Cas n°1 :  Votre site internet recueille lui-même les candidatures](https://doc.api-engagement.beta.gouv.fr/annoncer-des-missions/tracking-des-candidatures/cas-n-1-votre-site-internet-recueille-lui-meme-les-candidatures.md)
- [Introduction : comment fonctionne le tracking de l'API Engagement ?](https://doc.api-engagement.beta.gouv.fr/annoncer-des-missions/tracking-des-candidatures/cas-n-1-votre-site-internet-recueille-lui-meme-les-candidatures/introduction-comment-fonctionne-le-tracking-de-lapi-engagement.md)
- [Rajout de la balise et des commandes de tracking par le tag (Implémentation simple et conseillée)](https://doc.api-engagement.beta.gouv.fr/annoncer-des-missions/tracking-des-candidatures/cas-n-1-votre-site-internet-recueille-lui-meme-les-candidatures/rajout-de-la-balise-et-des-commandes-de-tracking-par-le-tag-implementation-simple-et-conseillee.md): Le tag est un moyen simple de suivre les activités de votre implémentation. Le tag de l'API Engagement" est un script JavaScript permettant de mesurer l'impact des redirections de l'API Engagement.
- [Tracking de l'activité par API (Implémentation manuelle)](https://doc.api-engagement.beta.gouv.fr/annoncer-des-missions/tracking-des-candidatures/cas-n-1-votre-site-internet-recueille-lui-meme-les-candidatures/tracking-de-lactivite-par-api-implementation-manuelle.md)
- [Tester votre intégration grâce à l'extension Chrome](https://doc.api-engagement.beta.gouv.fr/annoncer-des-missions/tracking-des-candidatures/cas-n-1-votre-site-internet-recueille-lui-meme-les-candidatures/tester-votre-integration-grace-a-lextension-chrome.md): L'extension Chrome « API Engagement Tag Assistant » rend chaque étape visible (script détecté, cookie posé, événements envoyés).
- [Dépannage](https://doc.api-engagement.beta.gouv.fr/annoncer-des-missions/tracking-des-candidatures/cas-n-1-votre-site-internet-recueille-lui-meme-les-candidatures/depannage.md)
- [Cas n°2 : Votre site internet ne permet pas de recueillir les candidatures](https://doc.api-engagement.beta.gouv.fr/annoncer-des-missions/tracking-des-candidatures/cas-n-2-votre-site-internet-ne-permet-pas-de-recueillir-les-candidatures.md)
- [Modération des missions partagées](https://doc.api-engagement.beta.gouv.fr/annoncer-des-missions/la-moderation-des-missions.md)
- [Modération API Engagement](https://doc.api-engagement.beta.gouv.fr/annoncer-des-missions/la-moderation-des-missions/moderation-api-engagement.md)
- [Modération des partenaires "diffuseur"](https://doc.api-engagement.beta.gouv.fr/annoncer-des-missions/la-moderation-des-missions/moderation-des-partenaires-diffuseur.md)
- [Diffuser des missions d'engagement sur mon site](https://doc.api-engagement.beta.gouv.fr/diffuser-des-missions/diffuser-des-missions-dengagement-sur-mon-site.md): Missions d'engagement = Missions de bénévolat et/ou volontariat
- [Diffuser des missions par API](https://doc.api-engagement.beta.gouv.fr/diffuser-des-missions/diffuser-des-missions-dengagement-sur-mon-site/diffuser-des-missions-par-api.md)
- [Diffuser des missions par widget](https://doc.api-engagement.beta.gouv.fr/diffuser-des-missions/diffuser-des-missions-dengagement-sur-mon-site/diffuser-des-missions-par-widget.md): Vous pouvez afficher des missions de l'API sur votre site web en quelques heures
- [Diffuser des missions par lien tracké](https://doc.api-engagement.beta.gouv.fr/diffuser-des-missions/diffuser-des-missions-dengagement-sur-mon-site/diffuser-des-missions-par-lien-tracke.md)
- [Modèle de données d'une mission d'engagement](https://doc.api-engagement.beta.gouv.fr/diffuser-des-missions/modele-de-donnees-dune-mission-dengagement.md): Cette page décrit le modèle de données d'une mission récupérée via l'API Engagement
- [Déprécié -  Modèle de données d'une mission d'engagement](https://doc.api-engagement.beta.gouv.fr/diffuser-des-missions/deprecie-modele-de-donnees-dune-mission-dengagement.md): Cette page décrit le modèle de données d'une mission récupérée via l'API Engagement
- [Partager les données de diffusion sur mon site à l'API Engagement](https://doc.api-engagement.beta.gouv.fr/diffuser-des-missions/tracking-des-candidatures.md)
- [Missions non diffusées sur mon site](https://doc.api-engagement.beta.gouv.fr/diffuser-des-missions/tracking-des-candidatures/missions-non-diffusees-sur-mon-site.md)
- [Partager vos statistiques de diffusions (impressions) à l'API Engagement](https://doc.api-engagement.beta.gouv.fr/diffuser-des-missions/tracking-des-candidatures/partager-vos-statistiques-de-diffusions-impressions-a-lapi-engagement.md)
- [Par envoi de fichier csv.](https://doc.api-engagement.beta.gouv.fr/diffuser-des-missions/tracking-des-candidatures/partager-vos-statistiques-de-diffusions-impressions-a-lapi-engagement/par-envoi-de-fichier-csv..md)
- [Par la mise en place d'un tag (ou pixel) sur votre site](https://doc.api-engagement.beta.gouv.fr/diffuser-des-missions/tracking-des-candidatures/partager-vos-statistiques-de-diffusions-impressions-a-lapi-engagement/par-la-mise-en-place-dun-tag-ou-pixel-sur-votre-site.md): Cet article explique comment mesurer les impressions et envoyer l'information à l'API Engagement de manière automatique.
- [Identifier l’origine d’une redirection à l’aide de tags](https://doc.api-engagement.beta.gouv.fr/diffuser-des-missions/tracking-des-candidatures/identifier-lorigine-dune-redirection-a-laide-de-tags.md)
- [/association](https://doc.api-engagement.beta.gouv.fr/etablissements/rna.md): L'API association facilite la recherche, la consultation et la mise à jour de la base des établissements liés aux associations. Une association contient un ou plusieurs établissements.
- [Éléments de design "Vignettes" par domaine de mission](https://doc.api-engagement.beta.gouv.fr/ressources/elements-de-design-vignettes-par-domaine-de-mission.md)
- [Traitement des données utilisateurs](https://doc.api-engagement.beta.gouv.fr/ressources/traitement-des-donnees-utilisateurs.md)

## API Reference

- [Introduction](https://doc.api-engagement.beta.gouv.fr/api-reference/introduction.md): Présentation de l'API Engagement et de ses cas d'usage
- [Authentification](https://doc.api-engagement.beta.gouv.fr/api-reference/authentification.md): Comment utiliser votre clé API pour authentifier vos requêtes
- [Erreurs](https://doc.api-engagement.beta.gouv.fr/api-reference/errors.md): Format des erreurs et liste des codes retournés par l'API
- [Mock offline](https://doc.api-engagement.beta.gouv.fr/api-reference/mockoon.md): Mock local de l'API publique pour les recettes partenaires hors internet
- [Créer / mettre à jour une mission](https://doc.api-engagement.beta.gouv.fr/api-reference/mission-mission/creer-mettre-a-jour.md): Crée une nouvelle mission ou met à jour une mission existante via son identifiant client.
- [Supprimer une mission](https://doc.api-engagement.beta.gouv.fr/api-reference/mission-mission/supprimer.md): Supprime une mission à partir de son identifiant client.
- [Récupérer des missions](https://doc.api-engagement.beta.gouv.fr/api-reference/mission-mission/recuperer.md): Récupérer toutes les missions de vos partenaires avec des filtres précis.
- [Rechercher dans les missions](https://doc.api-engagement.beta.gouv.fr/api-reference/mission-mission/rechercher.md): Rechercher dans les missions de vos partenaires avec des filtres précis. A noter que vous récupérez des facets sur certains champs.
- [Récupérer une mission par identifiant](https://doc.api-engagement.beta.gouv.fr/api-reference/mission-mission/par-identifiant.md): Récupère le détail d'une mission à partir de son identifiant unique.
- [Récupérer vos missions](https://doc.api-engagement.beta.gouv.fr/api-reference/mes-missions-mymission/recuperer.md): Récupérer l’ensemble de vos missions disponibles via l’API Engagement.
- [Récupérer votre mission par identifiant](https://doc.api-engagement.beta.gouv.fr/api-reference/mes-missions-mymission/par-identifiant.md): Récupérer les données de la mission correspondant à l’identifiant fourni en paramètre, avec un champ "stats" indiquant le nombre de candidatures et de redirections générées.
- [Récupérer les statistiques d'une mission](https://doc.api-engagement.beta.gouv.fr/api-reference/mes-missions-mymission/statistiques.md): Récupérer uniquement les statistiques d’une mission, incluant le nombre de candidatures et de redirections, sans inclure les données de la mission.
- [Qualifier une candidature](https://doc.api-engagement.beta.gouv.fr/api-reference/tracking-activity/qualifier.md): Déclare ou met à jour une activité (impression, clic, candidature) associée à une mission.
- [Récupérer la liste des partenaires diffuseurs](https://doc.api-engagement.beta.gouv.fr/api-reference/diffuseur-publisher/liste.md): Récupérer la liste de l'ensemble des partenaires qui diffusent vos missions et redirigent du traffic vers votre site.
- [Récupérer un partenaire diffuseur](https://doc.api-engagement.beta.gouv.fr/api-reference/diffuseur-publisher/par-identifiant.md): Récupère les informations détaillées d'un partenaire diffuseur à partir de son identifiant.
- [Comprendre les règles de diffusion](https://doc.api-engagement.beta.gouv.fr/api-reference/regles-de-diffusion-diffusion-rule/diffusion.md): Comprendre le fonctionnement des règles de diffusion entre annonceurs et diffuseurs.
- [Lister les règles de diffusion](https://doc.api-engagement.beta.gouv.fr/api-reference/regles-de-diffusion-diffusion-rule/liste.md): Récupère, pour chacun de vos diffuseurs, les règles de diffusion configurées.
- [Créer une règle de diffusion](https://doc.api-engagement.beta.gouv.fr/api-reference/regles-de-diffusion-diffusion-rule/creer.md): Crée une règle de diffusion appliquée à un ou plusieurs de vos diffuseurs.
- [Supprimer une règle de diffusion](https://doc.api-engagement.beta.gouv.fr/api-reference/regles-de-diffusion-diffusion-rule/supprimer.md): Supprime une règle de diffusion rattachée à votre compte annonceur.
- [Récupérer les organisations](https://doc.api-engagement.beta.gouv.fr/api-reference/organisations-organization/recuperer.md): Récupérer les informations d'une organisation depuis la base de données centralisée alimentée par l'INSEE et data-subvention, incluant des informations légales sur l'organisation (dont RNA, SIRET).