Πιστοποίηση

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

Βασική URL

https://api.badges.ninja

Όλα τα endpoints API είναι σχετικά με αυτή τη βασική URL.

Πιστοποίηση με κλειδί API

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

Λήψη κλειδιού API

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

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

Από το API:

Τα κλειδιά API μπορούν επίσης να διαχειρίζονται μέσω του API χρησιμοποιώντας το JWT token σας από τη ροή πιστοποίησης 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 strings
• Τα αιτήματα POST και PUT στέλνουν ένα JSON body με ένα αντικείμενο 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"
    }
  }'

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

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

Όρια ποσοστού

Τα αιτήματα API υπόκεινται σε όρια ποσοστού. Εάν υπερβείτε το όριο, λαμβάνετε απάντηση 429 Too Many Requests. Περιμένετε μερικά δευτερόλεπτα και επαναλάβετε.

Δημόσια endpoints

Ορισμένα endpoints δεν απαιτούν πιστοποίηση. Αυτά είναι τα δημόσια endpoints επαλήθευσης υπό το /certify-badge/ που επιτρέπουν σε οποιονδήποτε να επαληθεύσει διαπιστευτήρια εμβλημάτων.