İçeriğe geç
Sursa Developers

POST/oauth/token

OAuth 2.0 belirteci verme

oauth_token

OAuth 2.0 belirteç uç noktası (RFC 6749, bölüm 3.2). grant_type: authorization_code tek kullanımlık bir kodu bir belirteç çiftiyle değiştirir ve code_verifier (PKCE S256) gerektirir; refresh_token bir yenileme belirteci karşılığında yeni bir çift verir ve önceki yenileme belirtecini geçersiz kılar (rotasyon), geçersiz kılınmış bir belirteci yeniden kullanmak ise tüm zinciri iptal eder; client_credentials, yalnızca confidential bir uygulama için, kuruluş adına yenileme belirteci olmadan bir belirteç verir. confidential bir istemci Authorization: Basic başlığıyla ya da client_id ve client_secret alanlarıyla kimlik doğrular; herkese açık bir istemci yalnızca client_id gönderir. Erişim belirteci 1 saat, yenileme belirteci 90 gün geçerlidir. Yanıtlar ve hatalar, Cache-Control: no-store ile RFC 6749, bölüm 5’e uyar. 1.62.0 sürümünde eklendi.

Kimlik doğrulama

Kimlik bilgisi gerekmez.

İstek gövdesi

application/x-www-form-urlencoded

Nesne: OAuthTokenRequest

  • grant_typestringzorunlu

    Geçerli değerler: authorization_coderefresh_tokenclient_credentials

  • codestring

    Yetkilendirme kodu (authorization_code).

  • redirect_uristring

    Yetkilendirme isteğindekiyle aynı yönlendirme URI’si (authorization_code).

  • code_verifierstring

    Özgün PKCE değeri, 43 ile 128 karakter arası (authorization_code).

  • refresh_tokenstring

    Yenileme belirteci (refresh_token).

  • scopestring

    Boşlukla ayrılmış kapsamlar, yalnızca daraltma için (refresh_token, client_credentials).

  • client_idstring

    Gizli değer Authorization: Basic başlığında gönderilmediğinde uygulama kimliği.

  • client_secretstring

    confidential bir uygulamanın istemci gizli değeri, Authorization: Basic başlığında gönderilmediğinde.

Yanıtlar

200Belirteçler verildi.

Yanıt başlıkları

  • RateLimit-Policy

    Geçerli limitler, IETF taslağı draft-ietf-httpapi-ratelimit-headers biçiminde: virgülle ayrılmış "<name>";q=<quota>;w=<window in seconds> öğeleri. key, API anahtarının istek hızıdır (kota ani artış payıdır, zaman penceresi bu payın tamamen dolma süresidir; oturum için user, kimlik bilgisi olmadan ip); minute, day ve month, kuruluşun UTC’ye göre takvim dakikası, günü ve ayı için kotalarıdır.

  • RateLimit

    RateLimit-Policy içindeki her limitten kalan: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    RateLimit-Policy içindeki en sıkı girdinin limiti (en az istek hakkı kalan girdi).

  • X-RateLimit-Remaining

    En sıkı limitte kalan istek sayısı.

  • X-RateLimit-Reset

    En sıkı limitin sıfırlanmasına kalan saniye.

application/json

Nesne: OAuthTokenResponse

  • access_tokenstringzorunlu

    Authorization: Bearer başlığı için erişim belirteci (kbat_…).

  • token_typestringzorunlu

    Geçerli değerler: Bearer

  • expires_inintegerzorunlu

    Erişim belirtecinin saniye cinsinden geçerlilik süresi.

  • refresh_tokenstring

    Yenileme belirteci (kbrt_…); client credentials için yoktur.

  • scopestringzorunlu

    Belirtecin boşlukla ayrılmış kapsamları.

400RFC 6749, bölüm 5.2’de tanımlanan hata.

Yanıt başlıkları

  • RateLimit-Policy

    Geçerli limitler, IETF taslağı draft-ietf-httpapi-ratelimit-headers biçiminde: virgülle ayrılmış "<name>";q=<quota>;w=<window in seconds> öğeleri. key, API anahtarının istek hızıdır (kota ani artış payıdır, zaman penceresi bu payın tamamen dolma süresidir; oturum için user, kimlik bilgisi olmadan ip); minute, day ve month, kuruluşun UTC’ye göre takvim dakikası, günü ve ayı için kotalarıdır.

  • RateLimit

    RateLimit-Policy içindeki her limitten kalan: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    RateLimit-Policy içindeki en sıkı girdinin limiti (en az istek hakkı kalan girdi).

  • X-RateLimit-Remaining

    En sıkı limitte kalan istek sayısı.

  • X-RateLimit-Reset

    En sıkı limitin sıfırlanmasına kalan saniye.

application/json

Nesne: OAuthErrorResponse

401Geçersiz istemci kimlik bilgileri (`invalid_client`).

Yanıt başlıkları

  • RateLimit-Policy

    Geçerli limitler, IETF taslağı draft-ietf-httpapi-ratelimit-headers biçiminde: virgülle ayrılmış "<name>";q=<quota>;w=<window in seconds> öğeleri. key, API anahtarının istek hızıdır (kota ani artış payıdır, zaman penceresi bu payın tamamen dolma süresidir; oturum için user, kimlik bilgisi olmadan ip); minute, day ve month, kuruluşun UTC’ye göre takvim dakikası, günü ve ayı için kotalarıdır.

  • RateLimit

    RateLimit-Policy içindeki her limitten kalan: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    RateLimit-Policy içindeki en sıkı girdinin limiti (en az istek hakkı kalan girdi).

  • X-RateLimit-Remaining

    En sıkı limitte kalan istek sayısı.

  • X-RateLimit-Reset

    En sıkı limitin sıfırlanmasına kalan saniye.

application/json

Nesne: OAuthErrorResponse

Güvenli yeniden denemeler

Her POST ve PATCH isteğiyle bir Idempotency-Key başlığı (örneğin bir UUID) gönderin. Aynı anahtarla 24 saat içinde yapılan yeniden deneme, isteği yeniden çalıştırmak yerine kaydedilmiş yanıtı döndürür.

Hız sınırları

Yanıtlarda RateLimit ve RateLimit-Policy başlıklarıyla birlikte daha eski X-RateLimit-Limit, X-RateLimit-Remaining ve X-RateLimit-Reset başlıkları bulunur. 429 yanıtında saniye cinsinden Retry-After başlığı vardır: bekleyin ve yeniden deneyin.

← oauth · API başvurusu