Vérification publique

Ces endpoints sont publics et ne nécessitent pas d'authentification. Ils permettent à quiconque de vérifier les certifications et de récupérer les données JSON Open Badge v2.0.

Tous les endpoints sont relatifs à https://api.badges.ninja.

Récupérer un émetteur

Récupère le JSON du profil émetteur Open Badge v2.0 pour un émetteur donné.

GET /certify-badge/issuer/{guid}

Exemple

curl https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-e5f6-7890-abcd-ef1234567890

Réponse

{
  "@context": "https://w3id.org/openbadges/v2",
  "type": "Issuer",
  "id": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-...",
  "name": "Acme Academy",
  "url": "https://acme.example.com",
  "email": "badges@acme.example.com",
  "verification": {
    "type": "hosted",
    "allowedOrigins": "api.badges.ninja"
  }
}

---

Récupérer un badge

Récupère le JSON BadgeClass Open Badge v2.0 pour un badge donné.

GET /certify-badge/badge/{guid}

Exemple

curl https://api.badges.ninja/certify-badge/badge/b1c2d3e4-f5a6-7890-bcde-f12345678901

Réponse

{
  "@context": "https://w3id.org/openbadges/v2",
  "type": "BadgeClass",
  "id": "https://api.badges.ninja/certify-badge/badge/b1c2d3e4-...",
  "name": "JavaScript Fundamentals",
  "description": "Demonstrates proficiency in core JavaScript concepts",
  "criteria": {
    "narrative": "Completed the JavaScript Fundamentals course with a score of 80% or higher"
  },
  "image": "https://ipfs.ninja/ipfs/Qm...",
  "issuer": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-..."
}

---

Récupérer une attribution

Récupère le JSON Assertion Open Badge v2.0 pour une attribution donnée.

GET /certify-badge/award/{guid}

Exemple

curl https://api.badges.ninja/certify-badge/award/c1d2e3f4-a5b6-7890-cdef-123456789012

Réponse

{
  "@context": "https://w3id.org/openbadges/v2",
  "type": "Assertion",
  "id": "https://api.badges.ninja/certify-badge/award/c1d2e3f4-...",
  "recipient": {
    "type": "email",
    "hashed": true,
    "identity": "sha256$..."
  },
  "badge": "https://api.badges.ninja/certify-badge/badge/b1c2d3e4-...",
  "issuedOn": "2025-01-15T00:00:00.000Z",
  "verification": {
    "type": "hosted"
  }
}

Notes

• L'e-mail du destinataire est haché (SHA-256) pour la confidentialité, conformément à la spéc Open Badge.
• Les réponses sont mises en cache pendant 1 heure (Cache-Control: public, max-age=3600).

---

Récupérer le texte de partage d'une attribution

Récupère le texte de partage personnalisé pour le badge d'une attribution.

GET /certify-badge/award/{guid}/share-text

Exemple

curl https://api.badges.ninja/certify-badge/award/c1d2e3f4-a5b6-7890-cdef-123456789012/share-text

Réponse

{
  "text": "I just earned the JavaScript Fundamentals badge! Check it out:"
}

Si aucun texte de partage personnalisé n'est défini, un message par défaut est renvoyé.

---

Envoyer l'e-mail d'attribution (public)

Envoie un e-mail de notification d'attribution depuis l'endpoint public. Utilisé par la page publique de partage.

POST /certify-badge/award/{guid}/send-email

Paramètres

Paramètre	Type	Obligatoire	Description
recipients	string	Oui	Liste d'e-mails séparés par des virgules
subject	string	Non	Objet de l'e-mail
message	string	Non	Message personnalisé à inclure dans l'e-mail

Exemple

curl -X POST https://api.badges.ninja/certify-badge/award/c1d2e3f4-a5b6-7890-cdef-123456789012/send-email \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "recipients": "colleague@example.com",
      "message": "Check out this badge!"
    }
  }'

Réponse

{
  "statusCode": 200,
  "info": "award sent"
}

---

Vérifier un émetteur

Vérifie un émetteur en cliquant sur le lien de vérification envoyé à son e-mail. On y accède généralement via le lien dans l'e-mail de vérification, pas en l'appelant directement.

GET /certify-badge/verify-issuer/{guid}/{code}

Paramètres

Paramètre	Type	Description
guid	string	Le GUID de l'émetteur
code	string	Le code de vérification

Réponse

Renvoie une page HTML confirmant si la vérification a réussi ou échoué. Cet endpoint est conçu pour être ouvert dans un navigateur.