Tietoskeemat: Todentaminen

dataTokenData Pakollinen

Vastausesimerkki · TokenData.

Esimerkki: {"access_token":"EXAMPLE_ACCESS_TOKEN","expires_at":"2026-01-01T12:15:00Z","expires_in":1800,"permissions":["orders.order:read"],"rate_limits":{"auth_per_minute":1,"read_per_minute":2,"write_per_minute":15},"token_type":"Bearer","warnings":[]}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Pakollinen

Vastauksen metatiedot.

Esimerkki: {"request_id":"example"}

Lisäkentät: Ei

dataTokenRevokedData Pakollinen

Vastausesimerkki · TokenRevokedData.

Esimerkki: {"revoked":true}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Pakollinen

Vastauksen metatiedot.

Esimerkki: {"request_id":"example-request"}

Lisäkentät: Ei

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:15:00Z"

expires_inKokonaislukuPakollinen

Todellinen voimassaoloaika sekunteina; tässä esimerkissä pyydetään 1800. Pyynnöt eivät pidennä sitä. expires_at on vanhenemisaika UTC-muodossa.

minimum: 300maximum: 3600

Esimerkki: 1800

permissionsTaulukko <Merkkijono> Pakollinen

permissions näyttää nykyiset voimassa olevat oikeudet: avaimen, sen luojan ja kaupan tilauksen oikeuksien leikkauksen, mukaan lukien aktiiviset lisäosat. Käyttöoikeus tarkistetaan jokaisella pyynnöllä.

Esimerkki: ["orders.order:read"]

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":1,"read_per_minute":2,"write_per_minute":15}

token_typeMerkkijonoValinnainen

Bearer. Palautetun tunnuksen todentamismenetelmä.

const: "Bearer"

Oletus: "Bearer"Esimerkki: "Bearer"

warningsTaulukko <TokenLifetimeWarning > Pakollinen

Alueen ulkopuolinen kokonaisluku asettaa 900 sekuntia ja palauttaa warnings-tiedot, joissa ovat token.ttl_out_of_range ja documentation_url osoitteeseen learn.shopently.com. Puuttuva kenttä ei aiheuta varoitusta; väärä tyyppi palauttaa 422.

Esimerkki: []

Lisäkentät: Ei

applied_secondsKokonaislukuValinnainen

900 s (15 min)

Oletus: 900

codeMerkkijonoValinnainen

token.ttl_out_of_range

const: "token.ttl_out_of_range"

Oletus: "token.ttl_out_of_range"

documentation_urlMerkkijonoValinnainen

https://learn.shopently.com/en/api/docs/authentication/#token-lifetime

Oletus: "https://learn.shopently.com/en/api/docs/authentication/#token-lifetime"

fieldMerkkijonoValinnainen

ttl_seconds

const: "ttl_seconds"

Oletus: "ttl_seconds"

max_secondsKokonaislukuValinnainen

3600 s (60 min)

Oletus: 3600

messageMerkkijonoValinnainen

Alueen ulkopuolinen kokonaisluku asettaa 900 sekuntia ja palauttaa warnings-tiedot, joissa ovat token.ttl_out_of_range ja documentation_url osoitteeseen learn.shopently.com. Puuttuva kenttä ei aiheuta varoitusta; väärä tyyppi palauttaa 422.

Oletus: "ttl_seconds must be between 300 and 3600 seconds. The default lifetime of 900 seconds was applied."

min_secondsKokonaislukuValinnainen

300 s (5 min)

Oletus: 300

Lisäkentät: Ei

auth_per_minuteKokonaislukuPakollinen

Myöntämis- ja peruutuspyynnöt minuutissa, myös epäonnistuneet todennukset. Molemmat jakavat auth-rajan.

minimum: 0maximum: 1000000

Esimerkki: 1

read_per_minuteKokonaislukuPakollinen

Lukupyyntöjä minuutissa.

minimum: 0maximum: 1000000

Esimerkki: 2

write_per_minuteKokonaislukuPakollinen

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

minimum: 0maximum: 1000000

Esimerkki: 15

Lisäkentät: Ei

ttl_secondsKokonaislukuValinnainen

Valinnainen kokonaisluku ttl_seconds: 300–3600 sekuntia (5–60 minuuttia). Jos kenttä puuttuu, oletus on 900 sekuntia (15 minuuttia).

Oletus: 900Esimerkki: 1800

Lisäkentät: Ei

access_tokenMerkkijonoPakollinen

Lähetä POST /api/v1/auth/revoke käyttäen myöntänyttä avainta Authorization: ApiKey -otsakkeessa ja tunnistetta JSON-kentässä access_token. Onnistumisen jälkeen seuraava käyttö palauttaa 401. Toistuva, tuntematon tai vieras tunniste palauttaa saman revoked: true; muiden avainten tunnisteita ei poisteta.

minLength: 1maxLength: 256

Esimerkki: "shpt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Lisäkentät: Ei

revokedTotuusarvoValinnainen

Lähetä POST /api/v1/auth/revoke käyttäen myöntänyttä avainta Authorization: ApiKey -otsakkeessa ja tunnistetta JSON-kentässä access_token. Onnistumisen jälkeen seuraava käyttö palauttaa 401. Toistuva, tuntematon tai vieras tunniste palauttaa saman revoked: true; muiden avainten tunnisteita ei poisteta.

const: true

Oletus: trueEsimerkki: true

Lisäkentät: Ei