Mærke-API

Administrér mærkeskabeloner — de beviser, du uddeler til modtagere.

Alle endpoints kræver godkendelse via X-Api-Key-headeren. Se Godkendelse.

Opret mærke

Opret et nyt mærke under en verificeret udsteder.

POST /badges

Parametre

Parameter	Type	Påkrævet	Beskrivelse
name	string	Ja	Mærketitel
description	string	Ja	Hvad mærket repræsenterer
criteria	string	Ja	Hvad modtageren gjorde for at opnå dette mærke
image	string	Ja	Base64-kodet billede (PNG eller JPG)
issuerId	string	Ja	ID'et for den verificerede udsteder

Eksempel

curl -X POST https://api.badges.ninja/badges \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "name": "JavaScript Fundamentals",
      "description": "Demonstrates proficiency in core JavaScript concepts",
      "criteria": "Completed the JavaScript Fundamentals course with a score of 80% or higher",
      "image": "data:image/png;base64,iVBORw0KGgo...",
      "issuerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  }'

Svar

{
  "statusCode": 200,
  "info": {
    "badgeId": "https://api.badges.ninja/certify-badge/badge/b1c2d3e4-f5a6-7890-bcde-f12345678901"
  }
}

Bemærkninger

• Udstederen skal være verificeret, før mærker kan oprettes.
• Billedet uploades til IPFS for permanent opbevaring.

---

Liste mærker

Hent alle mærker, du har oprettet.

GET /badges

Eksempel

curl -X GET https://api.badges.ninja/badges \
  -H "X-Api-Key: bws_your_api_key_here"

Svar

{
  "statusCode": 200,
  "info": {
    "badges": [
      {
        "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..." },
        "image": "https://ipfs.ninja/ipfs/Qm...",
        "issuer": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-...",
        "timestamp": "2025-01-15T10:30:00.000Z"
      }
    ]
  }
}

---

Opdatér mærke

Opdatér et eksisterende mærke. Kun de felter, du angiver, ændres.

PUT /badges/{badgeId}

Parametre

Parameter	Type	Påkrævet	Beskrivelse
badgeId	string	Ja	Mærke-ID (stiparameter)
name	string	Nej	Ny mærketitel
description	string	Nej	Ny beskrivelse
criteria	string	Nej	Nye kriterier
image	string	Nej	Nyt base64-kodet billede

Eksempel

curl -X PUT https://api.badges.ninja/badges/b1c2d3e4-f5a6-7890-bcde-f12345678901 \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "badgeId": "b1c2d3e4-f5a6-7890-bcde-f12345678901",
      "name": "JavaScript Fundamentals v2",
      "description": "Updated description for the JS badge"
    }
  }'

Svar

{
  "statusCode": 200,
  "info": {
    "badgeId": "https://api.badges.ninja/certify-badge/badge/b1c2d3e4-...",
    "updated": true
  }
}

---

Opdatér delingstekst

Sæt den tilpassede tekst, der vises, når modtagere deler dette mærke på sociale medier.

PUT /badges/{badgeId}/share-text

Parametre

Parameter	Type	Påkrævet	Beskrivelse
badgeId	string	Ja	Mærke-ID (stiparameter)
text	string	Ja	Delingstekst (ingen HTML tilladt)

Eksempel

curl -X PUT https://api.badges.ninja/badges/b1c2d3e4-f5a6-7890-bcde-f12345678901/share-text \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "badgeId": "b1c2d3e4-f5a6-7890-bcde-f12345678901",
      "text": "I just earned the JavaScript Fundamentals badge! Check it out:"
    }
  }'

Svar

{
  "statusCode": 200,
  "info": {
    "updated": true
  }
}

---

Slet mærke

Slet et mærke. Mærket må ikke have nogen udmærkelser.

DELETE /badges/{badgeId}

Eksempel

curl -X DELETE https://api.badges.ninja/badges/b1c2d3e4-f5a6-7890-bcde-f12345678901 \
  -H "X-Api-Key: bws_your_api_key_here"

Svar

{
  "statusCode": 200,
  "info": {
    "deleted": true
  }
}

Fejl

• 400 — mærket har udmærkelser og kan ikke slettes
• 404 — mærket blev ikke fundet