Preskoči na sadržaj
Sursa Developers

POST/oauth/token

Izdavanje OAuth 2.0 tokena

oauth_token

Krajnja točka za izdavanje tokena OAuth 2.0 (RFC 6749, odjeljak 3.2). grant_type: authorization_code mijenja jednokratni kod za par tokena i zahtijeva code_verifier (PKCE S256); refresh_token izdaje novi par za token za osvježavanje i poništava prethodni token za osvježavanje (rotacija), a ponovna upotreba poništenog tokena opoziva cijeli lanac; client_credentials izdaje token u ime organizacije, samo za aplikaciju confidential, bez tokena za osvježavanje. Klijent confidential autentificira se zaglavljem Authorization: Basic ili poljima client_id i client_secret; javni klijent šalje samo client_id. Pristupni token vrijedi 1 sat, a token za osvježavanje 90 dana. Odgovori i pogreške slijede RFC 6749, odjeljak 5, s Cache-Control: no-store. Dodano u verziji 1.62.0.

Autentifikacija

Vjerodajnice nisu potrebne.

Tijelo zahtjeva

application/x-www-form-urlencoded

Objekt: OAuthTokenRequest

  • grant_typestringobavezno

    Dopuštene vrijednosti: authorization_coderefresh_tokenclient_credentials

  • codestring

    Autorizacijski kod (authorization_code).

  • redirect_uristring

    Isti URI za preusmjeravanje kao u zahtjevu za autorizaciju (authorization_code).

  • code_verifierstring

    Izvorna PKCE vrijednost, od 43 do 128 znakova (authorization_code).

  • refresh_tokenstring

    Token za osvježavanje (refresh_token).

  • scopestring

    Opsezi odvojeni razmakom, samo za sužavanje (refresh_token, client_credentials).

  • client_idstring

    ID aplikacije, kad tajna nije proslijeđena u zaglavlju Authorization: Basic.

  • client_secretstring

    Tajna klijenta aplikacije confidential, kad nije proslijeđena u zaglavlju Authorization: Basic.

Odgovori

200Tokeni su izdani.

Zaglavlja odgovora

  • RateLimit-Policy

    Ograničenja na snazi, u formatu IETF nacrta draft-ietf-httpapi-ratelimit-headers: stavke odvojene zarezima "<name>";q=<quota>;w=<window in seconds>. key je učestalost zahtjeva API ključa (kvota je nalet, prozor je vrijeme do njegova potpunog obnavljanja; za sesiju je to user, bez vjerodajnica ip); minute, day i month su kvote organizacije za kalendarsku minutu, dan i mjesec po UTC-u.

  • RateLimit

    Što je preostalo od svakog ograničenja u RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Ograničenje najstrože stavke u RateLimit-Policy (one s najmanje preostalih zahtjeva).

  • X-RateLimit-Remaining

    Preostali zahtjevi u okviru najstrožeg ograničenja.

  • X-RateLimit-Reset

    Broj sekundi do obnove najstrožeg ograničenja.

application/json

Objekt: OAuthTokenResponse

  • access_tokenstringobavezno

    Pristupni token (kbat_…) za zaglavlje Authorization: Bearer.

  • token_typestringobavezno

    Dopuštene vrijednosti: Bearer

  • expires_inintegerobavezno

    Trajanje pristupnog tokena u sekundama.

  • refresh_tokenstring

    Token za osvježavanje (kbrt_…); nema ga za client credentials.

  • scopestringobavezno

    Opsezi tokena odvojeni razmakom.

400Pogreška kako je definirana u RFC 6749, odjeljak 5.2.

Zaglavlja odgovora

  • RateLimit-Policy

    Ograničenja na snazi, u formatu IETF nacrta draft-ietf-httpapi-ratelimit-headers: stavke odvojene zarezima "<name>";q=<quota>;w=<window in seconds>. key je učestalost zahtjeva API ključa (kvota je nalet, prozor je vrijeme do njegova potpunog obnavljanja; za sesiju je to user, bez vjerodajnica ip); minute, day i month su kvote organizacije za kalendarsku minutu, dan i mjesec po UTC-u.

  • RateLimit

    Što je preostalo od svakog ograničenja u RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Ograničenje najstrože stavke u RateLimit-Policy (one s najmanje preostalih zahtjeva).

  • X-RateLimit-Remaining

    Preostali zahtjevi u okviru najstrožeg ograničenja.

  • X-RateLimit-Reset

    Broj sekundi do obnove najstrožeg ograničenja.

401Nevaljane vjerodajnice klijenta (`invalid_client`).

Zaglavlja odgovora

  • RateLimit-Policy

    Ograničenja na snazi, u formatu IETF nacrta draft-ietf-httpapi-ratelimit-headers: stavke odvojene zarezima "<name>";q=<quota>;w=<window in seconds>. key je učestalost zahtjeva API ključa (kvota je nalet, prozor je vrijeme do njegova potpunog obnavljanja; za sesiju je to user, bez vjerodajnica ip); minute, day i month su kvote organizacije za kalendarsku minutu, dan i mjesec po UTC-u.

  • RateLimit

    Što je preostalo od svakog ograničenja u RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Ograničenje najstrože stavke u RateLimit-Policy (one s najmanje preostalih zahtjeva).

  • X-RateLimit-Remaining

    Preostali zahtjevi u okviru najstrožeg ograničenja.

  • X-RateLimit-Reset

    Broj sekundi do obnove najstrožeg ograničenja.

Sigurni ponovni pokušaji

Uz svaki POST i PATCH pošaljite zaglavlje Idempotency-Key (na primjer UUID). Ponovni pokušaj s istim ključem unutar 24 sata vraća spremljeni odgovor umjesto da ponovno izvrši zahtjev.

Ograničenja učestalosti

Odgovori sadrže zaglavlja RateLimit i RateLimit-Policy te ranija zaglavlja X-RateLimit-Limit, X-RateLimit-Remaining i X-RateLimit-Reset. Odgovor 429 sadrži zaglavlje Retry-After u sekundama: pričekajte i pokušajte ponovno.

← oauth · Referenca API-ja