Έλεγχος ταυτότητας

Όλα τα αιτήματα προς το API του badges.ninja απαιτούν έλεγχο ταυτότητας. Αυτή η σελίδα εξηγεί πώς να πιστοποιείτε τα αιτήματά σας.

Βασικό URL

https://api.badges.ninja

Όλα τα endpoints είναι σχετικά με αυτό το βασικό URL.

Έλεγχος ταυτότητας με κλειδί API

Η κύρια μέθοδος ελέγχου ταυτότητας είναι ένα κλειδί API που αποστέλλεται στην κεφαλίδα X-Api-Key.

Απόκτηση κλειδιού API

Από τον πίνακα ελέγχου:

1. Συνδεθείτε στο badges.ninja.
2. Μεταβείτε στο API Keys στην πλαϊνή γραμμή.
3. Κάντε κλικ στο Create API Key.
4. Αντιγράψτε το κλειδί (εμφανίζεται μόνο μία φορά).

Από το API:

Τα κλειδιά API μπορούν επίσης να διαχειρίζονται μέσω του API χρησιμοποιώντας το διακριτικό JWT από τη ροή ελέγχου ταυτότητας του Cognito. Για την απλούστερη προσέγγιση, χρησιμοποιήστε τον πίνακα ελέγχου.

Χρήση του κλειδιού API

Συμπεριλάβετε την κεφαλίδα X-Api-Key σε κάθε αίτημα:

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

Μορφή του κλειδιού API

Τα κλειδιά χρησιμοποιούν το πρόθεμα bws_:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Μορφή αιτημάτων

• Τα αιτήματα GET περνούν τις παραμέτρους ως συμβολοσειρά ερωτήματος (query string)
• Τα αιτήματα POST και PUT στέλνουν σώμα JSON με ένα αντικείμενο parameters
• Όλες οι απαντήσεις επιστρέφουν JSON με Content-Type: application/json

Δομή αιτημάτων POST/PUT

{
  "parameters": {
    "name": "My Badge",
    "description": "A sample badge"
  }
}

Παράδειγμα αιτήματος

curl -X POST https://api.badges.ninja/issuers \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "name": "My Organization",
      "url": "https://example.com",
      "email": "admin@example.com"
    }
  }'

Παράδειγμα απάντησης

{
  "issuerId": "https://api.badges.ninja/certify-badge/issuer/abc123-def456"
}

Δημόσια endpoints

Ορισμένα endpoints δεν απαιτούν έλεγχο ταυτότητας. Πρόκειται για τα δημόσια endpoints επαλήθευσης υπό το /certify-badge/, τα οποία επιτρέπουν σε οποιονδήποτε να επαληθεύσει ψηφιακά διαπιστευτήρια.