> For the complete documentation index, see [llms.txt](https://doc.api-engagement.beta.gouv.fr/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](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 API

## Étape 1 : créer une clé API dans le tableau de bord

Votre clé API est disponible directement dans votre compte API Engagement : vous la générez vous-même, sans avoir à la demander à quelqu'un ni à la recevoir par e-mail.

**Si vous avez déjà un compte**

1. Connectez-vous au tableau de bord API Engagement.
2. Allez dans **Diffuser des missions > Flux par API**.
3. Cliquez sur **Générer ma clé API** (ou **Régénérer** si vous en aviez déjà une), puis copiez-la.

<figure><img src="https://2489729786-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FG18aCd8mNuBlmkXXgR3Q%2Fuploads%2FZqNikSIGgmRMYbibV5h5%2Fimage.png?alt=media&amp;token=b9e6d011-913a-4965-8557-1fee96df8c93" alt=""><figcaption></figcaption></figure>

**Si vous n'avez pas encore de compte**

{% hint style="danger" %}
**Cette étape nécessite l'aide d'un chargé de déploiement** avec qui vous êtes en contact. Cette personne pourra générer cette clé pour vous.
{% endhint %}

Rapprochez-vous de votre chargé de déploiement : il crée votre compte diffuseur, active l'accès API et vous envoie une invitation. Vous recevez alors un e-mail pour définir votre mot de passe, puis vous suivez les 3 étapes ci-dessus.

> **Bon à savoir.** Votre clé donne accès aux données de missions et à vos statistiques de diffusion (clics, candidatures). Elle ne doit jamais circuler par e-mail ou par messagerie, y compris avec l'équipe API Engagement : personne n'a besoin de vous la transmettre, ni de vous la demander. En cas de doute sur sa confidentialité, régénérez-la depuis cette même page, l'ancienne clé est immédiatement désactivée.

## Étape 2 : récupérer les missions

L'**endpoint /mission permet de récupérer les missions** qui vous sont disponibles. [Voir la documentation](/api-reference/mission-mission/recuperer.md).

## Étape 3 : formater le visuel des missions récupérées via l'API sur votre site

#### Page 1 : Présenter une liste de mission d'engagement sur une page dédiée sur votre site

L'utilisateur accède à la liste des missions **récupérées via l'API Engagement** sur votre plateforme. Exemple d'implémentation

{% hint style="success" %}
*Exemple d'intégration*

* *Cette page propose des filtres  (comme la localisation, la date de début, la durée de la mission, le domaine (le thème), et le type d'engagement (bénévolat ou volontariat)*
* *Cette page propose également la liste des missions que vous diffusez avec les informations clés (titre de la mission, nom de la structure d'accueil, adresse d'exécution de la mission, domaine, type d'engagement). Pour rappel,* [*le modèle de données de missions récupérables est disponible ici*](/diffuser-des-missions/modele-de-donnees-dune-mission-dengagement.md)*.*
  {% endhint %}

<figure><img src="https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FG18aCd8mNuBlmkXXgR3Q%2Fuploads%2FtPt5UamOZ1KQ99sS4YdL%2Fimage.png?alt=media&#x26;token=3c1b5c77-d6dc-4d2d-94cf-684f402ac9bb" alt=""><figcaption><p>Page "liste de missions"</p></figcaption></figure>

**Page 2** : En cliquant sur une carte "mission", l'utilisateur peut alors consulter le détail des missions de bénévolat ou de volontariat avant de cliquer sur le **bouton d'action** que vous aurez ajouté à cette page.

L'utilisateur est alors **redirigé** sur le site de l'annonceur de la mission et peut proposer sa candidature.

<figure><img src="https://2489729786-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FG18aCd8mNuBlmkXXgR3Q%2Fuploads%2F8c4VBbb6HboXNlpV1Hk8%2Fimage.png?alt=media&amp;token=cdb9c291-8702-4262-bf48-f0ca5de135f6" alt=""><figcaption><p>Exemple de page de détail de mission</p></figcaption></figure>

NB : Retrouvez plus d'informations sur notre site vitrine 👇🏻

{% embed url="<https://api-engagement.beta.gouv.fr/diffuser-les-missions-de-partenaires/#api>" %}

## Étape 4 : Paramétrer le tracking des diffusions de missions

{% hint style="danger" %}
Cette étape est obligatoire pour pourvoir diffuser les missions de l'API Engagement.

Cet [article](/diffuser-des-missions/tracking-des-candidatures.md) décrit comment mettre en place le tracking obligatoire des vues que vous générerez sur votre site / application.
{% endhint %}