API Engagement API

Overview

L'API Engagement permet aux organisations de publier et diffuser des annonces de bénévolat et de volontariat. ### A quoi sert l’API Engagement ? L’API Engagement facilite la diffusion des missions de bénévolat et de volontariat partout en France. C’est un service public numérique gratuit qui permet aux plateformes d’engagement publiques et privées de mettre en commun leurs missions. L'API permet ainsi d'augmenter la visibilité des annonces et le taux d’occupation des places offertes aux potentiels bénévoles et volontaires. Concrètement, chaque plateforme peut intégrer l’API pour diffuser ses missions vers les autres plateformes partenaires d'une part, et récupérer les missions disponibles sur les autres plateformes selon des critères spécifiques comme la localisation, le domaine d’action, etc. Le tableau de bord de l’API permet à chaque partenaire de configurer les flux de missions entrant/sortant et de mesurer la contribution de chaque plateforme en missions et en trafic. ### Données accessibles dans l'API L'API Engagement permet de publier les données suivantes pour chaque annonce : Les champs requis : | Champ | Description | | -------------- | -------------------------------------- | | title | Titre de votre mission | | description | La description de votre mission | | clientId | L'identifiant interne de votre mission | | applicationUrl | L'url vers votre annonce | Les champs générés par l'API : L'api génère automatiquement les champs suivant : - publisherId : - publisherN

API Engagement is a government API from Ministères de l'Éducation nationale. Requests are authenticated with credentials issued on request. It is served over HTTPS.

At a glance

Authentication

Restricted access

HTTPS

Yes

CORS

Unknown

Category

Government

Base URL

https://api.api-engagement.beta.gouv.fr

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

curl -X GET "https://api.api-engagement.beta.gouv.fr" \
  -H "Accept: application/json"

const response = await fetch("https://api.api-engagement.beta.gouv.fr", {
  method: "GET",
  headers: {
    "Accept": "application/json",
  },
});
const data = await response.json();
console.log(data);

import requests

response = requests.request(
    "GET",
    "https://api.api-engagement.beta.gouv.fr",
    headers={
    "Accept": "application/json",
    },
    timeout=30,
)
print(response.json())

Questions