API de Micro-Certif

Attribuez vos badges Open Badges 3.0 directement depuis votre site, votre plateforme de formation ou votre outil métier, sans ressaisie et sans quitter votre environnement.

Présentation générale

L’API de Micro-Certif relie votre site à votre compte émetteur. Lorsqu’une personne a rempli vos conditions (formation terminée, dossier validé par un jury, projet réussi…), votre site demande à Micro-Certif d’émettre le badge. Micro-Certif génère le badge signé, prévient le bénéficiaire par e-mail et recueille son accord.

L’API suit les principes REST, répond en JSON et fonctionne de serveur à serveur : c’est votre serveur qui dialogue avec Micro-Certif, jamais le navigateur de vos visiteurs. Vos identifiants ne sont donc jamais exposés dans une page web.

Ce que vous pouvez faire avec l’API

Attribuer un badge depuis votre site

Un simple appel avec le prénom, le nom et l’e-mail du bénéficiaire suffit. S’il n’existe pas encore dans votre compte, il est créé automatiquement.

Recueillir l’accord du bénéficiaire

Chaque attribution déclenche un e-mail d’acceptation. Le badge ne devient officiel qu’une fois accepté ; vous pouvez renvoyer l’e-mail à tout moment.

Suivre l’état de chaque badge

Votre site interroge l’API pour savoir si un badge est en attente, accepté ou refusé, et l’affiche dans vos propres tableaux de bord.

Fixer une durée de validité

Vous indiquez la date d’attribution et, si vous le souhaitez, une date d’expiration. Un badge expiré ou refusé peut être attribué à nouveau.

Éviter les doublons

Si la personne détient déjà le badge en cours de validité, l’API renvoie l’attribution existante sans en créer une seconde. Un appel relancé après une coupure réseau est sans risque.

Travailler en sécurité

Chaque intégration possède sa clé et son secret. Les échanges se font uniquement en HTTPS, les appels sont journalisés, et une intégration peut être coupée immédiatement.

La création et la mise en forme des badges (titre, image, critères) se font dans votre espace Micro-Certif. L’API sert à les attribuer et à en suivre l’état. Une fois vos badges créés et paramétrés sur votre compte "Emetteur", vous n'avez quasiment plus à vous connecter sur Micro-Certif : tout se passe directement sur votre site !

Comment ça fonctionne

  1. Décision sur votre site. Une personne habilitée valide l’obtention du badge (ou votre système le fait automatiquement, par exemple à la fin d’une formation).
  2. Appel à l’API. Votre serveur transmet à Micro-Certif le numéro du badge, l’identité et l’e-mail du bénéficiaire, et les dates.
  3. Contrôles. Micro-Certif vérifie votre intégration, votre abonnement, et que le badge appartient bien à votre compte.
  4. Émission. Le badge est généré et signé au standard Open Badges 3.0, puis le bénéficiaire reçoit un e-mail d’acceptation.
  5. Acceptation. Le bénéficiaire accepte (ou refuse) depuis l’e-mail.
  6. Suivi. Votre site lit l’état du badge et l’affiche où vous le souhaitez : espace personnel, page publique, certificat.

Mise en route

  1. Disposer d’un compte émetteur. L’API est rattachée à un compte émetteur Micro-Certif avec un abonnement en cours.
  2. Préparer vos badges. Créez-les dans votre espace Micro-Certif et relevez le numéro de chacun.
  3. Demander votre accès. Contactez-nous en indiquant l’adresse de votre site : nous créons votre intégration et vous remettons une clé publique (mc_pub_…) et une clé secrète (mc_secret_…).
  4. Brancher votre site. Votre développeur enregistre les deux clés (publique et secrète) dans un fichier de configuration côté serveur, puis appelle l’API au moment où le badge doit être attribué. Un client PHP prêt à l’emploi est fourni sur demande.
  5. Vérifier. Appelez GET /me pour contrôler vos identifiants, puis attribuez un badge à votre propre adresse e-mail pour dérouler tout le parcours.

La clé secrète ne doit jamais apparaître dans une page web, dans du JavaScript ou dans un dépôt de code public. En cas de doute, demandez-nous de le régénérer : l’ancien cesse aussitôt de fonctionner.

Référence technique

Adresse et authentification

Adresse de base : https://micro-certif.com/api/v1 (HTTPS obligatoire).
Chaque requête porte deux en-têtes :

X-MC-Key: mc_pub_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
X-MC-Secret: mc_secret_xxxxxxxxxxxxxxxxxxxxxxxx

Points d’accès

MéthodeCheminRôle
GET/meVérifie les identifiants et renvoie l’état du compte (abonnement, bénéficiaires restants)
GET/badgesListe des badges que vous pouvez attribuer
POST/attributionsAttribue un badge à une personne
GET/attributions/{id}État d’une attribution
POST/attributions/{id}/renvoyerRenvoie l’e-mail d’acceptation (l’ancien lien est annulé)

Attribuer un badge

ChampObligatoireFormat
badge_idouiNuméro du badge
prenom, nomouiTexte, 100 caractères au plus
emailouiAdresse e-mail du bénéficiaire
date_attributionnonAAAA-MM-JJ (par défaut : aujourd’hui)
date_expirationnonAAAA-MM-JJ
evidence_notenonJustification inscrite dans le badge, 2000 caractères au plus
evidence_urlnonAdresse web d’une preuve
paysnonTexte

Exemple avec cURL

curl -X POST https://micro-certif.com/api/v1/attributions \
  -H "X-MC-Key: mc_pub_…" \
  -H "X-MC-Secret: mc_secret_…" \
  -H "Content-Type: application/json" \
  -d '{
        "badge_id": 7,
        "prenom": "Julie",
        "nom": "Martin",
        "email": "julie.martin@exemple.fr",
        "date_expiration": "2029-10-03"
      }'

Exemple avec le client PHP fourni

$mc = new MicroCertifClient('https://micro-certif.com/api/v1', MC_API_KEY, MC_API_SECRET);

$r = $mc->attribuer([
    'badge_id' => 7,
    'prenom'   => 'Julie',
    'nom'      => 'Martin',
    'email'    => 'julie.martin@exemple.fr',
]);

if ($r['ok']) {
    $id = $r['data']['attribution']['id'];   // à conserver pour le suivi
} else {
    echo $r['message'];                      // $r['code'] : code d'erreur stable
}

Réponses

Toutes les réponses sont en JSON, sous la même forme :

{ "success": true,
  "data": {
    "attribution": {
      "id": 1542,
      "statut": "en_attente",
      "badge_id": 7,
      "badge_nom": "Nom du badge",
      "badge_image_url": "https://micro-certif.com/…",
      "date_attribution": "2026-10-03",
      "date_expiration": "2029-10-03",
      "expire": false,
      "date_reponse": null,
      "credential_url": "https://micro-certif.com/…",
      "email_envoye": true
    },
    "deja_attribue": false
  }
}

{ "success": false,
  "error": { "code": "SUBSCRIPTION_EXPIRED", "message": "L'abonnement Micro-Certif de ce compte a expiré." }
}

Le champ statut vaut en_attente, accepte ou refuse. Une création renvoie le code HTTP 201 ; si le badge était déjà attribué, la réponse est 200 avec deja_attribue: true.

Principaux codes d’erreur

CodeHTTPSignification
UNAUTHORIZED401Clé ou secret absent ou invalide
INTEGRATION_DISABLED403Intégration désactivée
SUBSCRIPTION_EXPIRED403Abonnement expiré
BENEFICIARY_QUOTA_REACHED403Nombre de bénéficiaires de l’abonnement atteint
BADGE_NOT_ALLOWED403Le badge n’appartient pas à votre compte
BADGE_INACTIVE409Badge désactivé dans votre espace
VALIDATION_ERROR422Champ manquant ou mal formé
NOT_FOUND404Attribution inconnue
ALREADY_ANSWERED409Renvoi d’e-mail alors que le bénéficiaire a déjà répondu
TOO_MANY_REQUESTS429Trop de requêtes : réessayez dans une minute
SERVER_ERROR500Erreur interne : réessayez plus tard

Bonnes pratiques

Exemples d’utilisation

Vous n’avez pas de développeur ? Nous le faisons pour vous

Micro-Certif propose un service de développement de modules de badgeage 100 % personnalisés, connectés à votre site. Nous concevons le module autour de votre fonctionnement, pas l’inverse.

Intégré à votre site

Le module s’installe dans vos pages existantes : bouton d’attribution au bon endroit, respect de vos rôles et de vos étapes de validation.

À vos couleurs

Page publique de présentation du badge et certificat imprimable, avec votre logo et votre charte graphique.

Suivi et statistiques

Tableau de suivi des personnes et des badges reçus, échéances de validité, exports et statistiques pour vos administrateurs.

Livré clé en main

Étude de votre besoin, développement, mise en service et accompagnement jusqu’au premier badge émis.

Chaque projet fait l’objet d’un devis. Contactez-nous en décrivant votre site et ce que vous souhaitez certifier.

Vous souhaitez connecter votre site à Micro-Certif ?

Créez d'abord votre compte Émetteur, sélectionnez votre abonnement et configurez vos badges associés à votre compte. Contactez-nous ensuite pour vous ouvrir l'accès à notre API et vous transmettre vos clés. Notre équipe peut accompagner votre développeur jusqu’au premier badge émis. Vous n'avez pas de ressources internes pour votre développement ? Nous développons directement votre interface de badgeage 100% personnalisée
(voir notre offre ci-dessus).

Demander un accès à l’API
Retour à l’accueil