Siirry sisältöön
ShopentlyLearn

Tietoskeemat: Todentaminen

Tietoskeemat: Todentaminen. API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

Tietoskeemat

Hae · Tunniste — Todentaminen — Vastaus

ApiResponse_TokenData_ · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.
dataTokenData Pakollinen

Vastausesimerkki · TokenData.

Esimerkki: {"access_token":"EXAMPLE_ACCESS_TOKEN","expires_at":"2026-01-01T12:00:00Z","expires_in":900,"rate_limits":{"auth_per_minute":10,"read_per_minute":60,"write_per_minute":10},"token_type":"Bearer"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Pakollinen

Vastauksen metatiedot.

Esimerkki: {"request_id":"example"}

Lisäkentät: Ei

Hae · Tunniste — Todentaminen — Vastaus

TokenData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.
access_tokenMerkkijonoPakollinen

Tunniste Authorization: Bearer -otsakkeeseen. Aseta SHOPENTLY_ACCESS_TOKEN ennen erillisen esimerkin suorittamista.

Esimerkki: "EXAMPLE_ACCESS_TOKEN"
expires_atMerkkijonoPakollinen

Vanhenemisajankohta UTC-ajassa. Nykyiset käyttörajoitukset voivat estää tunnisteen käytön jo aiemmin.

format: "date-time"
Esimerkki: "2026-01-01T12:00:00Z"
expires_inKokonaislukuValinnainen

900 sekuntia eli 15 minuuttia myöntämisestä. Pyyntöjen tekeminen ei pidennä voimassaoloa.

Oletus: 900Esimerkki: 900
rate_limitsTokenRateLimitsData Pakollinen

Engine ≥ 4.143.0. Jokainen tokenvastaus sisältää myöntämishetken kauppakäytännön data.rate_limits-arvot. Kaikki avaimet jakavat nämä kiintiöt; uusi token ei nollaa niitä. Tilausmuutos voi tulla voimaan ennen tokenin vanhenemista.

Esimerkki: {"auth_per_minute":10,"read_per_minute":60,"write_per_minute":10}
token_typeMerkkijonoValinnainen

Bearer. Palautetun tunnuksen todentamismenetelmä.

const: "Bearer"
Oletus: "Bearer"Esimerkki: "Bearer"

Lisäkentät: Ei

Pyyntörajat

TokenRateLimitsData · Engine ≥ 4.143.0. Jokainen tokenvastaus sisältää myöntämishetken kauppakäytännön data.rate_limits-arvot. Kaikki avaimet jakavat nämä kiintiöt; uusi token ei nollaa niitä. Tilausmuutos voi tulla voimaan ennen tokenin vanhenemista. Nolla tarkoittaa, ettei toiminto ole käytettävissä, ei rajatonta käyttöä.
auth_per_minuteKokonaislukuPakollinen

Tokenpyyntöjä minuutissa, mukaan lukien epäonnistuneet tunnistautumisyritykset.

minimum: 0maximum: 1000000
Esimerkki: 10
read_per_minuteKokonaislukuPakollinen

Lukupyyntöjä minuutissa.

minimum: 0maximum: 1000000
Esimerkki: 60
write_per_minuteKokonaislukuPakollinen

Kirjoituspyyntöjä minuutissa; arvo ei myönnä kirjoitusoikeuksia.

minimum: 0maximum: 1000000
Esimerkki: 10

Lisäkentät: Ei

Hae · Tunniste — Todentaminen — Pyynnön sisältö

TokenRequest · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.
ObjektiLisäkentät: Ei

Lisäkentät: Ei