Μετάβαση στο περιεχόμενο
Sursa Developers

POST/oauth/token

Έκδοση διακριτικού OAuth 2.0

oauth_token

Το τελικό σημείο έκδοσης διακριτικών του OAuth 2.0 (RFC 6749, ενότητα 3.2). grant_type: το authorization_code ανταλλάσσει έναν κωδικό μίας χρήσης με ένα ζεύγος διακριτικών και απαιτεί code_verifier (PKCE S256)· το refresh_token εκδίδει νέο ζεύγος για ένα διακριτικό ανανέωσης και ακυρώνει το προηγούμενο διακριτικό ανανέωσης (εναλλαγή), και η επαναχρησιμοποίηση ενός ακυρωμένου ανακαλεί ολόκληρη την αλυσίδα· το client_credentials εκδίδει διακριτικό εκ μέρους του οργανισμού, μόνο για εφαρμογή confidential, χωρίς διακριτικό ανανέωσης. Ένας πελάτης confidential ταυτοποιείται με την κεφαλίδα Authorization: Basic ή με τα πεδία client_id και client_secret· ένας δημόσιος πελάτης στέλνει μόνο το client_id. Ένα διακριτικό πρόσβασης ισχύει για 1 ώρα, ένα διακριτικό ανανέωσης για 90 ημέρες. Οι αποκρίσεις και τα σφάλματα ακολουθούν το RFC 6749, ενότητα 5, με Cache-Control: no-store. Προστέθηκε στην έκδοση 1.62.0.

Έλεγχος ταυτότητας

Δεν απαιτούνται διαπιστευτήρια.

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

application/x-www-form-urlencoded

Αντικείμενο: OAuthTokenRequest

  • grant_typestringυποχρεωτικό

    Επιτρεπόμενες τιμές: authorization_coderefresh_tokenclient_credentials

  • codestring

    Κωδικός εξουσιοδότησης (authorization_code).

  • redirect_uristring

    Το ίδιο URI ανακατεύθυνσης με εκείνο του αιτήματος εξουσιοδότησης (authorization_code).

  • code_verifierstring

    Η αρχική τιμή PKCE, από 43 έως 128 χαρακτήρες (authorization_code).

  • refresh_tokenstring

    Ανανέωση (refresh_token).

  • scopestring

    Εμβέλειες χωρισμένες με κενά, μόνο για περιορισμό (refresh_token, client_credentials).

  • client_idstring

    ID της εφαρμογής, όταν το μυστικό δεν περνιέται στην κεφαλίδα Authorization: Basic.

  • client_secretstring

    Μυστικό πελάτη μιας εφαρμογής confidential, όταν δεν περνιέται στην κεφαλίδα Authorization: Basic.

Αποκρίσεις

200Τα διακριτικά εκδόθηκαν.

Κεφαλίδες απόκρισης

  • RateLimit-Policy

    Τα όρια σε ισχύ, στη μορφή του προσχεδίου IETF draft-ietf-httpapi-ratelimit-headers: στοιχεία χωρισμένα με κόμμα "<name>";q=<quota>;w=<window in seconds>. Το key είναι ο ρυθμός αιτημάτων του κλειδιού API (η ποσόστωση είναι η ριπή, το παράθυρο είναι ο χρόνος για την πλήρη αναπλήρωσή της· για μια συνεδρία είναι user, χωρίς διαπιστευτήρια ip)· τα minute, day και month είναι οι ποσοστώσεις του οργανισμού για το ημερολογιακό λεπτό, την ημέρα και τον μήνα σε UTC.

  • RateLimit

    Τι απομένει από κάθε όριο του RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Όριο της αυστηρότερης εγγραφής του RateLimit-Policy (εκείνης με τα λιγότερα εναπομείναντα αιτήματα).

  • X-RateLimit-Remaining

    Αιτήματα που απομένουν στο αυστηρότερο όριο.

  • X-RateLimit-Reset

    Δευτερόλεπτα έως τον μηδενισμό του αυστηρότερου ορίου.

application/json

Αντικείμενο: OAuthTokenResponse

  • access_tokenstringυποχρεωτικό

    Διακριτικό πρόσβασης (kbat_…) για την κεφαλίδα Authorization: Bearer.

  • token_typestringυποχρεωτικό

    Επιτρεπόμενες τιμές: Bearer

  • expires_inintegerυποχρεωτικό

    Διάρκεια ισχύος του διακριτικού πρόσβασης σε δευτερόλεπτα.

  • refresh_tokenstring

    Διακριτικό ανανέωσης (kbrt_…)· λείπει για client credentials.

  • scopestringυποχρεωτικό

    Εμβέλειες του διακριτικού, χωρισμένες με κενά.

400Σφάλμα όπως ορίζεται στο RFC 6749, ενότητα 5.2.

Κεφαλίδες απόκρισης

  • RateLimit-Policy

    Τα όρια σε ισχύ, στη μορφή του προσχεδίου IETF draft-ietf-httpapi-ratelimit-headers: στοιχεία χωρισμένα με κόμμα "<name>";q=<quota>;w=<window in seconds>. Το key είναι ο ρυθμός αιτημάτων του κλειδιού API (η ποσόστωση είναι η ριπή, το παράθυρο είναι ο χρόνος για την πλήρη αναπλήρωσή της· για μια συνεδρία είναι user, χωρίς διαπιστευτήρια ip)· τα minute, day και month είναι οι ποσοστώσεις του οργανισμού για το ημερολογιακό λεπτό, την ημέρα και τον μήνα σε UTC.

  • RateLimit

    Τι απομένει από κάθε όριο του RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Όριο της αυστηρότερης εγγραφής του RateLimit-Policy (εκείνης με τα λιγότερα εναπομείναντα αιτήματα).

  • X-RateLimit-Remaining

    Αιτήματα που απομένουν στο αυστηρότερο όριο.

  • X-RateLimit-Reset

    Δευτερόλεπτα έως τον μηδενισμό του αυστηρότερου ορίου.

application/json

Αντικείμενο: OAuthErrorResponse

401Μη έγκυρα διαπιστευτήρια πελάτη (`invalid_client`).

Κεφαλίδες απόκρισης

  • RateLimit-Policy

    Τα όρια σε ισχύ, στη μορφή του προσχεδίου IETF draft-ietf-httpapi-ratelimit-headers: στοιχεία χωρισμένα με κόμμα "<name>";q=<quota>;w=<window in seconds>. Το key είναι ο ρυθμός αιτημάτων του κλειδιού API (η ποσόστωση είναι η ριπή, το παράθυρο είναι ο χρόνος για την πλήρη αναπλήρωσή της· για μια συνεδρία είναι user, χωρίς διαπιστευτήρια ip)· τα minute, day και month είναι οι ποσοστώσεις του οργανισμού για το ημερολογιακό λεπτό, την ημέρα και τον μήνα σε UTC.

  • RateLimit

    Τι απομένει από κάθε όριο του RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Όριο της αυστηρότερης εγγραφής του RateLimit-Policy (εκείνης με τα λιγότερα εναπομείναντα αιτήματα).

  • X-RateLimit-Remaining

    Αιτήματα που απομένουν στο αυστηρότερο όριο.

  • X-RateLimit-Reset

    Δευτερόλεπτα έως τον μηδενισμό του αυστηρότερου ορίου.

application/json

Αντικείμενο: OAuthErrorResponse

Ασφαλείς επαναλήψεις

Στείλτε μια κεφαλίδα Idempotency-Key (για παράδειγμα ένα UUID) με κάθε POST και PATCH. Μια επανάληψη με το ίδιο κλειδί εντός 24 ωρών επιστρέφει την αποθηκευμένη απόκριση αντί να εκτελέσει ξανά το αίτημα.

Όρια ρυθμού

Οι αποκρίσεις περιέχουν τις κεφαλίδες RateLimit και RateLimit-Policy, καθώς και τις παλαιότερες X-RateLimit-Limit, X-RateLimit-Remaining και X-RateLimit-Reset. Μια απόκριση 429 έχει την κεφαλίδα Retry-After σε δευτερόλεπτα: περιμένετε και επαναλάβετε το αίτημα.

← oauth · Αναφορά API