API odznak

Zarządzaj szablonami odznak — poświadczeniami, które wydajesz odbiorcom.

Wszystkie endpointy wymagają uwierzytelnienia przez nagłówek X-Api-Key. Zobacz Uwierzytelnianie.

Utwórz odznakę

Utwórz nową odznakę pod zweryfikowanym wystawcą.

POST /badges

Parametry

Parametr	Typ	Wymagany	Opis
name	string	Tak	Tytuł odznaki
description	string	Tak	Co reprezentuje odznaka
criteria	string	Tak	Co odbiorca zrobił, aby zdobyć tę odznakę
image	string	Tak	Obraz zakodowany w Base64 (PNG lub JPG)
issuerId	string	Tak	Identyfikator zweryfikowanego wystawcy

Przykład

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"
    }
  }'

Odpowiedź

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

Uwagi

• Wystawca musi być zweryfikowany przed utworzeniem odznaki.
• Obraz jest wgrywany do IPFS w celu trwałego przechowywania.

---

Lista odznak

Pobierz wszystkie odznaki, które utworzyłeś.

GET /badges

Przykład

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

Odpowiedź

{
  "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"
      }
    ]
  }
}

---

Zaktualizuj odznakę

Zaktualizuj istniejącą odznakę. Zmieniane są tylko pola, które podasz.

PUT /badges/{badgeId}

Parametry

Parametr	Typ	Wymagany	Opis
badgeId	string	Tak	Identyfikator odznaki (parametr ścieżki)
name	string	Nie	Nowy tytuł odznaki
description	string	Nie	Nowy opis
criteria	string	Nie	Nowe kryteria
image	string	Nie	Nowy obraz zakodowany w Base64

Przykład

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"
    }
  }'

Odpowiedź

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

---

Zaktualizuj tekst udostępnienia

Ustaw własny tekst wyświetlany, gdy odbiorcy udostępniają tę odznakę w mediach społecznościowych.

PUT /badges/{badgeId}/share-text

Parametry

Parametr	Typ	Wymagany	Opis
badgeId	string	Tak	Identyfikator odznaki (parametr ścieżki)
text	string	Tak	Tekst udostępnienia (HTML niedozwolony)

Przykład

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:"
    }
  }'

Odpowiedź

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

---

Usuń odznakę

Usuń odznakę. Odznaka nie może mieć żadnych wydań.

DELETE /badges/{badgeId}

Przykład

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

Odpowiedź

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

Błędy

• 400 — odznaka ma wydania i nie można jej usunąć
• 404 — odznaka nie znaleziona