Κλειδιά API

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

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

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

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

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

Κάθε γραμμή εμφανίζει επίσης πότε δημιουργήθηκε το κλειδί και, μόλις χρησιμοποιηθεί, μια χρονική σήμανση τελευταίας χρήσης, ώστε να εντοπίζετε τα ανενεργά κλειδιά.

Εύρη πρόσβασης

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

Εύρος	Επιτρέπει
Πλήρης πρόσβαση (προεπιλογή)	Ανάγνωση και εγγραφή — προβολή δεδομένων και δημιουργία, έκδοση, ενημέρωση ή διαγραφή.
Μόνο για ανάγνωση	Μόνο ασφαλή αιτήματα 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

Λήξη κλειδιών

Κάθε κλειδί API λήγει ένα έτος μετά τη δημιουργία του. Όταν ένα κλειδί λήξει, παύει να πιστοποιεί αιτήματα, ακριβώς σαν να είχε διαγραφεί. Δημιουργήστε νέο κλειδί πριν λήξει το παλιό, για να αποφύγετε διακοπές.

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

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

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