API Key Διαχείριση

Προβολή ως Markdown

Τα τελικά σημεία διαχείρισης API Key δέχονται μόνο έλεγχο ταυτότητας JWT.

Δημιουργήστε API Key

1POST /v1/private/user/api-key/create
2Authorization: Bearer YOUR_ACCESS_TOKEN
3Content-Type: application/json

Παράμετροι αιτήματος:

ΠαράμετροςΤύποςΑπαιτείταιΠεριγραφή
labelstringΝαιAPI Key ετικέτα, μήκος 1 - 64
permissionsΔιεθνέςΌχιΜάσκα bit άδειας, προεπιλεγμένη 1, εύρος 1 - 7
ipWhitelistσυμβολοσειρά[]ΌχιIP λίστα επιτρεπόμενων, έως 20 καταχωρήσεις. Εάν παραλειφθεί, η IP πηγής είναι απεριόριστη

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

$curl -X POST https://api.6mm.com/v1/private/user/api-key/create \
> -H "Content-Type: application/json" \
> -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
> -d '{
> "label": "external-service-prod",
> "permissions": 3,
> "ipWhitelist": ["203.0.113.10"]
> }'

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

1{
2 "code": 0,
3 "message": "success",
4 "data": {
5 "apiKey": "fx_xxxxxxxxxxxxxxxxxxxxxxxx",
6 "apiSecret": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
7 },
8 "requestId": "req-api-key"
9}

apiSecret επιστρέφεται μόνο μία φορά κατά τη δημιουργία του API Key . Αποθηκεύστε το αμέσως σε ένα μυστικό σύστημα διαχείρισης. Μην το γράφετε σε αποθετήρια πηγαίου κώδικα ή αρχεία καταγραφής.

Κάθε χρήστης μπορεί να δημιουργήσει έως και 30 API κλειδιά.

Λίστα API κλειδιών

1GET /v1/private/user/api-key/list
2Authorization: Bearer YOUR_ACCESS_TOKEN

Πεδία απόκρισης:

ΠεδίοΤύποςΠεριγραφή
list[].idstringAPI Key ταυτότητα
list[].labelstringΕτικέτα
list[].apiKeystringΑναγνωριστικό δημόσιου API Key
list[].permissionsΔιεθνέςΆδεια bitmask
list[].ipWhitelistσυμβολοσειρά[]IP λίστα επιτρεπόμενων
list[].statusΔιεθνέςΚατάσταση: 1 ενεργοποιημένο, 0 απενεργοποιημένο
list[].lastUsedAtint64Χρόνος τελευταίας χρήσης
list[].createdAtint64Χρόνος δημιουργίας

Ενημέρωση API Key

1PUT /v1/private/user/api-key/update
2Authorization: Bearer YOUR_ACCESS_TOKEN
3Content-Type: application/json

Παράμετροι αιτήματος:

ΠαράμετροςΤύποςΑπαιτείταιΠεριγραφή
idstringΝαιAPI Key ταυτότητα
labelstringΌχιΝέα ετικέτα
permissionsΔιεθνέςΌχιΝέα άδεια bitmask
ipWhitelistσυμβολοσειρά[]ΌχιΝέα λίστα επιτρεπόμενων IP
statusΔιεθνέςΌχι1 ενεργοποιημένο, 0 απενεργοποιημένο

Διαγραφή API Key

1POST /v1/private/user/api-key/delete
2Authorization: Bearer YOUR_ACCESS_TOKEN
3Content-Type: application/json

Σώμα αιτήματος:

1{ "id": "1001" }

Διαγραφή όλων των πλήκτρων API

1POST /v1/private/user/api-key/delete-all
2Authorization: Bearer YOUR_ACCESS_TOKEN
3Content-Type: application/json

Πεδία απόκρισης:

ΠεδίοΤύποςΠεριγραφή
deletedint64Αριθμός διαγραμμένων κλειδιών API