Badges API

Διαχειριστείτε πρότυπα εμβλημάτων — τα διαπιστευτήρια που απονέμετε σε παραλήπτες.

Όλα τα endpoints απαιτούν πιστοποίηση μέσω της κεφαλίδας X-Api-Key. Δείτε Πιστοποίηση.

Δημιουργία εμβλήματος

Δημιουργήστε ένα νέο έμβλημα υπό έναν επαληθευμένο εκδότη.

POST /badges

Παράμετροι

Παράμετρος	Τύπος	Υποχρεωτικό	Περιγραφή
name	string	Ναι	Τίτλος εμβλήματος
description	string	Ναι	Τι αντιπροσωπεύει το έμβλημα
criteria	string	Ναι	Τι έκανε ο παραλήπτης για να αποκτήσει αυτό το έμβλημα
image	string	Ναι	Εικόνα κωδικοποιημένη σε Base64 (PNG ή JPG)
issuerId	string	Ναι	Το ID του επαληθευμένου εκδότη

Παράδειγμα

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

Απάντηση

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

Σημειώσεις

• Ο εκδότης πρέπει να είναι επαληθευμένος πριν δημιουργηθούν εμβλήματα.
• Η εικόνα μεταφορτώνεται στο IPFS για μόνιμη αποθήκευση.

---

Λίστα εμβλημάτων

Ανακτήστε όλα τα εμβλήματα που έχετε δημιουργήσει.

GET /badges

Παράδειγμα

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

Απάντηση

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

---

Ενημέρωση εμβλήματος

Ενημερώστε ένα υπάρχον έμβλημα. Μόνο τα πεδία που παρέχετε αλλάζουν.

PUT /badges/{badgeId}

Παράμετροι

Παράμετρος	Τύπος	Υποχρεωτικό	Περιγραφή
badgeId	string	Ναι	Το ID του εμβλήματος (παράμετρος διαδρομής)
name	string	Όχι	Νέος τίτλος εμβλήματος
description	string	Όχι	Νέα περιγραφή
criteria	string	Όχι	Νέα κριτήρια
image	string	Όχι	Νέα εικόνα κωδικοποιημένη σε base64

Παράδειγμα

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

Απάντηση

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

---

Ενημέρωση κειμένου κοινοποίησης

Ορίστε το προσαρμοσμένο κείμενο που εμφανίζεται όταν οι παραλήπτες μοιράζονται αυτό το έμβλημα στα μέσα κοινωνικής δικτύωσης.

PUT /badges/{badgeId}/share-text

Παράμετροι

Παράμετρος	Τύπος	Υποχρεωτικό	Περιγραφή
badgeId	string	Ναι	Το ID του εμβλήματος (παράμετρος διαδρομής)
text	string	Ναι	Κείμενο κοινοποίησης (χωρίς HTML)

Παράδειγμα

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

Απάντηση

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

---

Διαγραφή εμβλήματος

Διαγράψτε ένα έμβλημα. Το έμβλημα δεν πρέπει να έχει απονομές.

DELETE /badges/{badgeId}

Παράδειγμα

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

Απάντηση

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

Σφάλματα

• 400 — το έμβλημα έχει απονομές και δεν μπορεί να διαγραφεί
• 404 — το έμβλημα δεν βρέθηκε