Pređi na sadržaj
ShopentlyLearn

Šeme podataka: Autentifikacija

Šeme podataka: Autentifikacija. Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.

Šeme podataka

Preuzmi · Token — Autentifikacija — Odgovor

ApiResponse_TokenData_ · Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.
dataTokenData Obavezno

Primer odgovora · TokenData.

Primer: {"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 Obavezno

Metapodaci odgovora.

Primer: {"request_id":"example"}

Dodatna polja: Ne

Opozovi token · ApiResponse

ApiResponse_TokenRevokedData_ · Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.
dataTokenRevokedData Obavezno

Primer odgovora · TokenRevokedData.

Primer: {"revoked":true}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obavezno

Metapodaci odgovora.

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

Dodatna polja: Ne

Preuzmi · Token — Autentifikacija — Odgovor

TokenData · Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.
access_tokenNiz znakovaObavezno

Token za zaglavlje Authorization: Bearer. Postavite SHOPENTLY_ACCESS_TOKEN pre pokretanja zasebnog primera.

Primer: "EXAMPLE_ACCESS_TOKEN"
expires_atNiz znakovaObavezno

Vreme isteka u UTC-u. Trenutna ograničenja pristupa mogu blokirati token ranije.

format: "date-time"
Primer: "2026-01-01T12:15:00Z"
expires_inCeli brojObavezno

Stvarno trajanje u sekundama; ovaj primer traži 1800. Zahtevi ga ne produžavaju. expires_at je vreme isteka u UTC-u.

minimum: 300maximum: 3600
Primer: 1800
permissionsNiz vrednosti <Niz znakova> Obavezno

permissions prikazuje trenutna efektivna prava: presek prava ključa, njegovog autora i paketa prodavnice, uključujući aktivne dodatke. Pristup se proverava pri svakom zahtevu.

Primer: ["orders.order:read"]
rate_limitsTokenRateLimitsData Obavezno

Engine ≥ 4.143.0. Svaki odgovor sa tokenom sadrži data.rate_limits iz pravila prodavnice u trenutku izdavanja. Svi ključevi dele ove limite; novi token ih ne resetuje. Promena plana može važiti pre isteka tokena.

Primer: {"auth_per_minute":1,"read_per_minute":2,"write_per_minute":15}
token_typeNiz znakovaOpciono

Bearer. Šema autentifikacije za vraćeni token.

const: "Bearer"
Podrazumevano: "Bearer"Primer: "Bearer"
warningsNiz vrednosti <TokenLifetimeWarning > Obavezno

Ceo broj van opsega postavlja 900 sekundi i vraća warnings sa token.ttl_out_of_range i documentation_url na learn.shopently.com. Izostavljeno polje ne izaziva upozorenje; pogrešan tip vraća 422.

Primer: []

Dodatna polja: Ne

TokenLifetimeWarning

TokenLifetimeWarning · Ceo broj van opsega postavlja 900 sekundi i vraća warnings sa token.ttl_out_of_range i documentation_url na learn.shopently.com. Izostavljeno polje ne izaziva upozorenje; pogrešan tip vraća 422.
applied_secondsCeli brojOpciono

900 s (15 min)

Podrazumevano: 900
codeNiz znakovaOpciono

token.ttl_out_of_range

const: "token.ttl_out_of_range"
Podrazumevano: "token.ttl_out_of_range"
documentation_urlNiz znakovaOpciono

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

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

ttl_seconds

const: "ttl_seconds"
Podrazumevano: "ttl_seconds"
max_secondsCeli brojOpciono

3600 s (60 min)

Podrazumevano: 3600
messageNiz znakovaOpciono

Ceo broj van opsega postavlja 900 sekundi i vraća warnings sa token.ttl_out_of_range i documentation_url na learn.shopently.com. Izostavljeno polje ne izaziva upozorenje; pogrešan tip vraća 422.

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

300 s (5 min)

Podrazumevano: 300

Dodatna polja: Ne

Ograničenja učestalosti

TokenRateLimitsData · Engine ≥ 4.143.0. Svaki odgovor sa tokenom sadrži data.rate_limits iz pravila prodavnice u trenutku izdavanja. Svi ključevi dele ove limite; novi token ih ne resetuje. Promena plana može važiti pre isteka tokena. Nula znači nedostupnost, a ne neograničeno korišćenje.
auth_per_minuteCeli brojObavezno

Zahtevi za izdavanje i opoziv tokena u minuti, uključujući neuspešnu autentikaciju. Obe operacije dele ograničenje auth.

minimum: 0maximum: 1000000
Primer: 1
read_per_minuteCeli brojObavezno

Zahtevi za čitanje u minutu.

minimum: 0maximum: 1000000
Primer: 2
write_per_minuteCeli brojObavezno

Zahtevi za upis u minutu; ova vrednost ne daje prava upisa.

minimum: 0maximum: 1000000
Primer: 15

Dodatna polja: Ne

Preuzmi · Token — Autentifikacija — Telo zahteva

TokenRequest · Polja, tipovi i ograničenja podataka koje API prihvata ili vraća.
ttl_secondsCeli brojOpciono

Opcioni ceo broj ttl_seconds: 300–3600 sekundi (5–60 minuta). Bez polja podrazumeva se 900 sekundi (15 minuta).

Podrazumevano: 900Primer: 1800

Dodatna polja: Ne

Opozovi token · TokenRevokeRequest

TokenRevokeRequest · Pošaljite POST /api/v1/auth/revoke sa ključem izdavaoca u Authorization: ApiKey i tokenom u JSON polju access_token. Posle uspeha sledeće korišćenje vraća 401. Ponovljen, nepoznat ili tuđ token vraća isto revoked: true; tokeni drugih ključeva se ne brišu.
access_tokenNiz znakovaObavezno

Pošaljite POST /api/v1/auth/revoke sa ključem izdavaoca u Authorization: ApiKey i tokenom u JSON polju access_token. Posle uspeha sledeće korišćenje vraća 401. Ponovljen, nepoznat ili tuđ token vraća isto revoked: true; tokeni drugih ključeva se ne brišu.

minLength: 1maxLength: 256
Primer: "shpt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Dodatna polja: Ne

Opozovi token · TokenRevokedData

TokenRevokedData · Pošaljite POST /api/v1/auth/revoke sa ključem izdavaoca u Authorization: ApiKey i tokenom u JSON polju access_token. Posle uspeha sledeće korišćenje vraća 401. Ponovljen, nepoznat ili tuđ token vraća isto revoked: true; tokeni drugih ključeva se ne brišu.
revokedLogička vrednostOpciono

Pošaljite POST /api/v1/auth/revoke sa ključem izdavaoca u Authorization: ApiKey i tokenom u JSON polju access_token. Posle uspeha sledeće korišćenje vraća 401. Ponovljen, nepoznat ili tuđ token vraća isto revoked: true; tokeni drugih ključeva se ne brišu.

const: true
Podrazumevano: truePrimer: true

Dodatna polja: Ne