Κλειδιά API

Τα κλειδιά API σας επιτρέπουν να έχετε πρόσβαση στο REST API του badges.ninja μέσω προγραμματισμού. Χρησιμοποιήστε τα για να αυτοματοποιήσετε τη δημιουργία, έκδοση και διαχείριση εμβλημάτων από τις δικές σας εφαρμογές.

Δημιουργία κλειδιού API

1. Ανοίξτε τη σελίδα API Keys από την πλαϊνή γραμμή.
2. Κάντε κλικ στο Create API Key. Ανοίγει μια ενσωματωμένη φόρμα:

3. Δώστε όνομα στο κλειδί και κάντε κλικ στο Create. Το πλήρες κλειδί αποκαλύπτεται μία φορά σε ένα πράσινο banner:

4. Αντιγράψτε το κλειδί άμεσα — εμφανίζεται μόνο μία φορά. Εάν το χάσετε, θα πρέπει να δημιουργήσετε ένα νέο. Αφού κλείσετε το banner, αποθηκεύεται μόνο το πρόθεμα:

Εμβέλειες Πρόσβασης

Όταν δημιουργείτε ένα κλειδί μπορείτε να το κάνετε μόνο για ανάγνωση ή να το αφήσετε με πλήρη πρόσβαση:

Εμβέλεια	Επιτρέπει
Πλήρης πρόσβαση (προεπιλογή)	Ανάγνωση και εγγραφή — προβολή δεδομένων και δημιουργία, έκδοση, ενημέρωση ή διαγραφή.
Μόνο για ανάγνωση	Μόνο ασφαλή αιτήματα GET. Οποιοδήποτε αίτημα τροποποίησης (POST, PUT, PATCH, DELETE) απορρίπτεται με 403 Forbidden.

Χρησιμοποιήστε ένα κλειδί μόνο για ανάγνωση για ενσωματώσεις που χρειάζεται μόνο να διαβάζουν τα δεδομένα σας (αναφορές, πίνακες ελέγχου, αντίγραφα ασφαλείας) ώστε ένα διαρρεύσαν κλειδί να μην μπορεί να αλλάξει τίποτα. Επιλέξτε Read-only key στη φόρμα δημιουργίας· τα κλειδιά μόνο για ανάγνωση εμφανίζουν ένα σήμα Read-only στη λίστα. Τα κλειδιά που δημιουργήθηκαν πριν υπάρξουν οι εμβέλειες διατηρούν πλήρη πρόσβαση.

Μορφή κλειδιού

Τα κλειδιά API χρησιμοποιούν το πρόθεμα bws_ ακολουθούμενο από μια συμβολοσειρά δεκαεξαδικών 32 χαρακτήρων:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Χρήση κλειδιών API σε αιτήματα

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

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

Δείτε τη σελίδα Πιστοποίηση για πλήρη λεπτομέρεια σχετικά με την πιστοποίηση API.

Όρια κλειδιών ανά πλάνο

Ο αριθμός των κλειδιών API που μπορείτε να δημιουργήσετε εξαρτάται από το πλάνο σας:

Πλάνο	Όριο κλειδιών API
Free	1
Starter ($9/mo)	5
Pro ($29/mo)	20

Διαγραφή κλειδιού

1. Ανοίξτε τη σελίδα API Keys.
2. Βρείτε το κλειδί που θέλετε να διαγράψετε.
3. Κάντε κλικ στο Delete.
4. Επιβεβαιώστε τη διαγραφή.

Μετά τη διαγραφή, το κλειδί σταματά αμέσως να λειτουργεί. Οποιαδήποτε εφαρμογή χρησιμοποιεί αυτό το κλειδί θα λάβει σφάλματα πιστοποίησης.