Modele uwierzytelniania

dataTokenData Wymagane

Przykład odpowiedzi · TokenData.

Przykład: {"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 Wymagane

Metadane odpowiedzi.

Przykład: {"request_id":"example"}

Dodatkowe pola: Nie

dataTokenRevokedData Wymagane

Przykład odpowiedzi · TokenRevokedData.

Przykład: {"revoked":true}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Wymagane

Metadane odpowiedzi.

Przykład: {"request_id":"example-request"}

Dodatkowe pola: Nie

access_tokenTekstWymagane

Token do nagłówka Authorization: Bearer. Przed osobnym przykładem ustaw go jako SHOPENTLY_ACCESS_TOKEN.

Przykład: "EXAMPLE_ACCESS_TOKEN"

expires_atTekstWymagane

Termin wygaśnięcia w UTC. Aktualne ograniczenia dostępu mogą zablokować token wcześniej.

format: "date-time"

Przykład: "2026-01-01T12:15:00Z"

expires_inLiczba całkowitaWymagane

Rzeczywisty czas ważności w sekundach; ten przykład wybiera 1800. Żądania go nie przedłużają. expires_at oznacza termin wygaśnięcia w UTC.

minimum: 300maximum: 3600

Przykład: 1800

permissionsTablica <Tekst> Wymagane

permissions zawiera bieżące skuteczne uprawnienia: część wspólną uprawnień klucza, jego autora i planu sklepu, wraz z aktywnymi uprawnieniami dodatków. Dostęp jest sprawdzany przy każdym żądaniu.

Przykład: ["orders.order:read"]

rate_limitsTokenRateLimitsData Wymagane

Engine ≥ 4.143.0. Każda odpowiedź z tokenem zawiera data.rate_limits z polityki sklepu obowiązującej przy jego wydaniu. Wszystkie klucze współdzielą te budżety; nowy token ich nie resetuje. Zmiana planu może obowiązywać przed wygaśnięciem tokenu.

Przykład: {"auth_per_minute":1,"read_per_minute":2,"write_per_minute":15}

token_typeTekstOpcjonalne

Bearer. Schemat uwierzytelniania zwróconego tokenu.

const: "Bearer"

Wartość domyślna: "Bearer"Przykład: "Bearer"

warningsTablica <TokenLifetimeWarning > Wymagane

Liczba całkowita spoza zakresu ustawia 900 sekund i zwraca warnings z token.ttl_out_of_range oraz documentation_url do learn.shopently.com. Brak pola nie powoduje ostrzeżenia; błędny typ zwraca 422.

Przykład: []

Dodatkowe pola: Nie

applied_secondsLiczba całkowitaOpcjonalne

900 s (15 min)

Wartość domyślna: 900

codeTekstOpcjonalne

token.ttl_out_of_range

const: "token.ttl_out_of_range"

Wartość domyślna: "token.ttl_out_of_range"

documentation_urlTekstOpcjonalne

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

Wartość domyślna: "https://learn.shopently.com/en/api/docs/authentication/#token-lifetime"

fieldTekstOpcjonalne

ttl_seconds

const: "ttl_seconds"

Wartość domyślna: "ttl_seconds"

max_secondsLiczba całkowitaOpcjonalne

3600 s (60 min)

Wartość domyślna: 3600

messageTekstOpcjonalne

Liczba całkowita spoza zakresu ustawia 900 sekund i zwraca warnings z token.ttl_out_of_range oraz documentation_url do learn.shopently.com. Brak pola nie powoduje ostrzeżenia; błędny typ zwraca 422.

Wartość domyślna: "ttl_seconds must be between 300 and 3600 seconds. The default lifetime of 900 seconds was applied."

min_secondsLiczba całkowitaOpcjonalne

300 s (5 min)

Wartość domyślna: 300

Dodatkowe pola: Nie

auth_per_minuteLiczba całkowitaWymagane

Żądania wydania i anulowania tokenu na minutę, także nieudane próby uwierzytelnienia. Obie operacje współdzielą limit auth.

minimum: 0maximum: 1000000

Przykład: 1

read_per_minuteLiczba całkowitaWymagane

Zapytania odczytu na minutę.

minimum: 0maximum: 1000000

Przykład: 2

write_per_minuteLiczba całkowitaWymagane

Zapytania zapisu na minutę; ta wartość nie nadaje uprawnień do zapisu.

minimum: 0maximum: 1000000

Przykład: 15

Dodatkowe pola: Nie

ttl_secondsLiczba całkowitaOpcjonalne

Opcjonalna liczba całkowita ttl_seconds: 300–3600 sekund (5–60 minut). Brak pola oznacza domyślnie 900 sekund (15 minut).

Wartość domyślna: 900Przykład: 1800

Dodatkowe pola: Nie

access_tokenTekstWymagane

Wyślij POST /api/v1/auth/revoke z kluczem, który wydał token, w Authorization: ApiKey i tokenem w polu JSON access_token. Po sukcesie kolejne użycie zwraca 401. Powtórzony, nieznany lub cudzy token daje to samo revoked: true; tokeny innych kluczy nie są usuwane.

minLength: 1maxLength: 256

Przykład: "shpt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Dodatkowe pola: Nie

revokedWartość logicznaOpcjonalne

Wyślij POST /api/v1/auth/revoke z kluczem, który wydał token, w Authorization: ApiKey i tokenem w polu JSON access_token. Po sukcesie kolejne użycie zwraca 401. Powtórzony, nieznany lub cudzy token daje to samo revoked: true; tokeny innych kluczy nie są usuwane.

const: true

Wartość domyślna: truePrzykład: true

Dodatkowe pola: Nie