Σχήματα δεδομένων
Ανάκτηση · Διακριτικό — Έλεγχος ταυτότητας — Απόκριση
ApiResponse_TokenData_ · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.
dataTokenDataΥποχρεωτικόΠαράδειγμα απόκρισης · TokenData.
metaContextPageMetaContextMetaPageMetaRequestMetaΥποχρεωτικόΜεταδεδομένα απόκρισης.
Πρόσθετα πεδία: Όχι
Ανάκληση token · ApiResponse
ApiResponse_TokenRevokedData_ · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.
dataTokenRevokedDataΥποχρεωτικόΠαράδειγμα απόκρισης · TokenRevokedData.
metaContextPageMetaContextMetaPageMetaRequestMetaΥποχρεωτικόΜεταδεδομένα απόκρισης.
Πρόσθετα πεδία: Όχι
Ανάκτηση · Διακριτικό — Έλεγχος ταυτότητας — Απόκριση
TokenData · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.
access_tokenΣυμβολοσειράΥποχρεωτικόΔιακριτικό για την κεφαλίδα Authorization: Bearer. Ορίστε το SHOPENTLY_ACCESS_TOKEN πριν εκτελέσετε το ξεχωριστό παράδειγμα.
expires_atΣυμβολοσειράΥποχρεωτικόΧρόνος λήξης σε UTC. Οι τρέχοντες περιορισμοί πρόσβασης μπορεί να αποκλείσουν το διακριτικό νωρίτερα.
format:"date-time"expires_inΑκέραιοςΥποχρεωτικόΠραγματική διάρκεια σε δευτερόλεπτα· αυτό το παράδειγμα ζητά 1800. Τα αιτήματα δεν την παρατείνουν. Το expires_at είναι η λήξη σε UTC.
minimum:300maximum:3600permissionsΠίνακας <Συμβολοσειρά> ΥποχρεωτικόΤο permissions δείχνει τα τρέχοντα ενεργά δικαιώματα: την τομή των δικαιωμάτων του κλειδιού, του δημιουργού του και του προγράμματος καταστήματος, μαζί με τα ενεργά πρόσθετα. Η πρόσβαση ελέγχεται σε κάθε αίτημα.
rate_limitsTokenRateLimitsDataΥποχρεωτικόEngine ≥ 4.143.0. Κάθε απάντηση token περιλαμβάνει το data.rate_limits της πολιτικής του καταστήματος κατά την έκδοση. Όλα τα κλειδιά μοιράζονται αυτά τα όρια· ένα νέο token δεν τα επαναφέρει. Αλλαγή προγράμματος μπορεί να ισχύσει πριν λήξει το token.
token_typeΣυμβολοσειράΠροαιρετικόBearer. Σχήμα ελέγχου ταυτότητας για το επιστρεφόμενο διακριτικό.
const:"Bearer"warningsΠίνακας <TokenLifetimeWarning> ΥποχρεωτικόΑκέραιος εκτός ορίων ορίζει 900 δευτερόλεπτα και επιστρέφει warnings με token.ttl_out_of_range και documentation_url στο learn.shopently.com. Η παράλειψη δεν παράγει προειδοποίηση· λάθος τύπος επιστρέφει 422.
Πρόσθετα πεδία: Όχι
TokenLifetimeWarning
TokenLifetimeWarning · Ακέραιος εκτός ορίων ορίζει 900 δευτερόλεπτα και επιστρέφει warnings με token.ttl_out_of_range και documentation_url στο learn.shopently.com. Η παράλειψη δεν παράγει προειδοποίηση· λάθος τύπος επιστρέφει 422.
applied_secondsΑκέραιοςΠροαιρετικό900 s (15 min)
codeΣυμβολοσειράΠροαιρετικόtoken.ttl_out_of_range
const:"token.ttl_out_of_range"documentation_urlΣυμβολοσειράΠροαιρετικόhttps://learn.shopently.com/en/api/docs/authentication/#token-lifetime
fieldΣυμβολοσειράΠροαιρετικόttl_seconds
const:"ttl_seconds"max_secondsΑκέραιοςΠροαιρετικό3600 s (60 min)
messageΣυμβολοσειράΠροαιρετικόΑκέραιος εκτός ορίων ορίζει 900 δευτερόλεπτα και επιστρέφει warnings με token.ttl_out_of_range και documentation_url στο learn.shopently.com. Η παράλειψη δεν παράγει προειδοποίηση· λάθος τύπος επιστρέφει 422.
min_secondsΑκέραιοςΠροαιρετικό300 s (5 min)
Πρόσθετα πεδία: Όχι
Όρια αιτημάτων
TokenRateLimitsData · Engine ≥ 4.143.0. Κάθε απάντηση token περιλαμβάνει το data.rate_limits της πολιτικής του καταστήματος κατά την έκδοση. Όλα τα κλειδιά μοιράζονται αυτά τα όρια· ένα νέο token δεν τα επαναφέρει. Αλλαγή προγράμματος μπορεί να ισχύσει πριν λήξει το token. Το μηδέν σημαίνει μη διαθέσιμο, όχι απεριόριστο.
auth_per_minuteΑκέραιοςΥποχρεωτικόΑιτήματα έκδοσης και ανάκλησης token ανά λεπτό, μαζί με αποτυχημένες ταυτοποιήσεις. Και οι δύο λειτουργίες μοιράζονται το όριο auth.
minimum:0maximum:1000000read_per_minuteΑκέραιοςΥποχρεωτικόΑιτήματα ανάγνωσης ανά λεπτό.
minimum:0maximum:1000000write_per_minuteΑκέραιοςΥποχρεωτικόΑιτήματα εγγραφής ανά λεπτό· η τιμή δεν εκχωρεί δικαιώματα εγγραφής.
minimum:0maximum:1000000
Πρόσθετα πεδία: Όχι
Ανάκτηση · Διακριτικό — Έλεγχος ταυτότητας — Περιεχόμενο αιτήματος
TokenRequest · Πεδία, τύποι και περιορισμοί δεδομένων που δέχεται ή επιστρέφει το API.
ttl_secondsΑκέραιοςΠροαιρετικόΠροαιρετικός ακέραιος ttl_seconds: 300–3600 δευτερόλεπτα (5–60 λεπτά). Αν λείπει, ισχύουν 900 δευτερόλεπτα (15 λεπτά).
Πρόσθετα πεδία: Όχι
Ανάκληση token · TokenRevokeRequest
TokenRevokeRequest · Στείλτε POST /api/v1/auth/revoke με το κλειδί έκδοσης στο Authorization: ApiKey και το token στο πεδίο JSON access_token. Μετά την επιτυχία, η επόμενη χρήση επιστρέφει 401. Επαναλαμβανόμενα, άγνωστα ή ξένα tokens λαμβάνουν το ίδιο revoked: true· tokens άλλων κλειδιών δεν διαγράφονται.
access_tokenΣυμβολοσειράΥποχρεωτικόΣτείλτε POST /api/v1/auth/revoke με το κλειδί έκδοσης στο Authorization: ApiKey και το token στο πεδίο JSON access_token. Μετά την επιτυχία, η επόμενη χρήση επιστρέφει 401. Επαναλαμβανόμενα, άγνωστα ή ξένα tokens λαμβάνουν το ίδιο revoked: true· tokens άλλων κλειδιών δεν διαγράφονται.
minLength:1maxLength:256
Πρόσθετα πεδία: Όχι
Ανάκληση token · TokenRevokedData
TokenRevokedData · Στείλτε POST /api/v1/auth/revoke με το κλειδί έκδοσης στο Authorization: ApiKey και το token στο πεδίο JSON access_token. Μετά την επιτυχία, η επόμενη χρήση επιστρέφει 401. Επαναλαμβανόμενα, άγνωστα ή ξένα tokens λαμβάνουν το ίδιο revoked: true· tokens άλλων κλειδιών δεν διαγράφονται.
revokedΛογική τιμήΠροαιρετικόΣτείλτε POST /api/v1/auth/revoke με το κλειδί έκδοσης στο Authorization: ApiKey και το token στο πεδίο JSON access_token. Μετά την επιτυχία, η επόμενη χρήση επιστρέφει 401. Επαναλαμβανόμενα, άγνωστα ή ξένα tokens λαμβάνουν το ίδιο revoked: true· tokens άλλων κλειδιών δεν διαγράφονται.
const:true
Πρόσθετα πεδία: Όχι