Skemi tad-data: Awtentikazzjoni

Skemi tad-data: Awtentikazzjoni. L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

Skemi tad-data

Ikseb · Token — Awtentikazzjoni — Risposta

ApiResponse_TokenData_ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

dataTokenData Obbligatorju: Eżempju ta’ tweġiba · TokenData.

Eżempju: {"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 Obbligatorju: Metadata tat-tweġiba.

Eżempju: {"request_id":"example"}

Oqsma addizzjonali: Le

Irrevoka t-token · ApiResponse

ApiResponse_TokenRevokedData_ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

dataTokenRevokedData Obbligatorju: Eżempju ta’ tweġiba · TokenRevokedData.

Eżempju: {"revoked":true}
metaContextPageMeta ContextMeta PageMeta RequestMeta Obbligatorju: Metadata tat-tweġiba.

Eżempju: {"request_id":"example-request"}

Oqsma addizzjonali: Le

Ikseb · Token — Awtentikazzjoni — Risposta

TokenData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

access_tokenStringObbligatorju: Token għall-intestatura Authorization: Bearer. Issettja SHOPENTLY_ACCESS_TOKEN qabel tħaddem l-eżempju separat.

Eżempju: "EXAMPLE_ACCESS_TOKEN"
expires_atStringObbligatorju: Il-ħin tal-iskadenza f’UTC. Ir-restrizzjonijiet attwali tal-aċċess jistgħu jimblukkaw it-token qabel.

format: "date-time"

Eżempju: "2026-01-01T12:15:00Z"
expires_inNumru sħiħObbligatorju: Il-validità effettiva f’sekondi; dan l-eżempju jitlob 1800. It-talbiet ma jestenduhiex. expires_at huwa l-ħin tal-iskadenza f’UTC.

minimum: 300maximum: 3600

Eżempju: 1800
permissionsArray <String> Obbligatorju: permissions juri l-permessi effettivi attwali: l-intersezzjoni tal-permessi taċ-ċavetta, tal-awtur tagħha u tal-pjan tal-ħanut, inklużi estensjonijiet attivi. L-aċċess jiġi vverifikat f’kull talba.

Eżempju: ["orders.order:read"]
rate_limitsTokenRateLimitsData Obbligatorju: Engine ≥ 4.143.0. Kull tweġiba tat-token tinkludi data.rate_limits mill-politika tal-ħanut fil-ħin tal-ħruġ. Iċ-ċwievet kollha jaqsmu dawn il-limiti; token ġdid ma jerġax jibdihom. Bidla fil-pjan tista’ tapplika qabel jiskadi t-token.

Eżempju: {"auth_per_minute":1,"read_per_minute":2,"write_per_minute":15}
token_typeStringMhux obbligatorju: Bearer. Skema tal-awtentikazzjoni għat-token mogħti.

const: "Bearer"

Valur predefinit: "Bearer"Eżempju: "Bearer"
warningsArray <TokenLifetimeWarning > Obbligatorju: Numru sħiħ barra l-firxa japplika 900 sekonda u jirritorna warnings b’token.ttl_out_of_range u documentation_url lejn learn.shopently.com. Qasam nieqes ma joħloqx twissija; tip invalidu jirritorna 422.

Eżempju: []

Oqsma addizzjonali: Le

TokenLifetimeWarning

TokenLifetimeWarning · Numru sħiħ barra l-firxa japplika 900 sekonda u jirritorna warnings b’token.ttl_out_of_range u documentation_url lejn learn.shopently.com. Qasam nieqes ma joħloqx twissija; tip invalidu jirritorna 422.

applied_secondsNumru sħiħMhux obbligatorju: 900 s (15 min)

Valur predefinit: 900
codeStringMhux obbligatorju: token.ttl_out_of_range

const: "token.ttl_out_of_range"

Valur predefinit: "token.ttl_out_of_range"
documentation_urlStringMhux obbligatorju: https://learn.shopently.com/en/api/docs/authentication/#token-lifetime

Valur predefinit: "https://learn.shopently.com/en/api/docs/authentication/#token-lifetime"
fieldStringMhux obbligatorju: ttl_seconds

const: "ttl_seconds"

Valur predefinit: "ttl_seconds"
max_secondsNumru sħiħMhux obbligatorju: 3600 s (60 min)

Valur predefinit: 3600
messageStringMhux obbligatorju: Numru sħiħ barra l-firxa japplika 900 sekonda u jirritorna warnings b’token.ttl_out_of_range u documentation_url lejn learn.shopently.com. Qasam nieqes ma joħloqx twissija; tip invalidu jirritorna 422.

Valur predefinit: "ttl_seconds must be between 300 and 3600 seconds. The default lifetime of 900 seconds was applied."
min_secondsNumru sħiħMhux obbligatorju: 300 s (5 min)

Valur predefinit: 300

Oqsma addizzjonali: Le

Limiti tar-rata

TokenRateLimitsData · Engine ≥ 4.143.0. Kull tweġiba tat-token tinkludi data.rate_limits mill-politika tal-ħanut fil-ħin tal-ħruġ. Iċ-ċwievet kollha jaqsmu dawn il-limiti; token ġdid ma jerġax jibdihom. Bidla fil-pjan tista’ tapplika qabel jiskadi t-token. Żero jfisser mhux disponibbli, mhux bla limitu.

auth_per_minuteNumru sħiħObbligatorju: Talbiet għall-ħruġ u r-revoka ta’ tokens kull minuta, inklużi tentattivi ta’ awtentikazzjoni li fallew. Iż-żewġ operazzjonijiet jaqsmu l-limitu auth.

minimum: 0maximum: 1000000

Eżempju: 1
read_per_minuteNumru sħiħObbligatorju: Talbiet għall-qari kull minuta.

minimum: 0maximum: 1000000

Eżempju: 2
write_per_minuteNumru sħiħObbligatorju: Talbiet għall-kitba kull minuta; dan il-valur ma jagħtix permessi għall-kitba.

minimum: 0maximum: 1000000

Eżempju: 15

Oqsma addizzjonali: Le

Ikseb · Token — Awtentikazzjoni — Kontenut tat-talba

TokenRequest · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

ttl_secondsNumru sħiħMhux obbligatorju: Numru sħiħ fakultattiv ttl_seconds: 300–3600 sekonda (5–60 minuta). Jekk il-qasam jitħalla barra, il-valur awtomatiku huwa 900 sekonda (15-il minuta).

Valur predefinit: 900Eżempju: 1800

Oqsma addizzjonali: Le

Irrevoka t-token · TokenRevokeRequest

TokenRevokeRequest · Ibgħat POST /api/v1/auth/revoke biċ-ċavetta li ħarġet it-token f’Authorization: ApiKey u t-token fil-qasam JSON access_token. Wara suċċess, l-użu li jmiss jirritorna 401. Token ripetut, mhux magħruf jew ta’ ħaddieħor jirċievi l-istess revoked: true; tokens ta’ ċwievet oħra ma jitħassrux.

access_tokenStringObbligatorju: Ibgħat POST /api/v1/auth/revoke biċ-ċavetta li ħarġet it-token f’Authorization: ApiKey u t-token fil-qasam JSON access_token. Wara suċċess, l-użu li jmiss jirritorna 401. Token ripetut, mhux magħruf jew ta’ ħaddieħor jirċievi l-istess revoked: true; tokens ta’ ċwievet oħra ma jitħassrux.

minLength: 1maxLength: 256

Eżempju: "shpt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Oqsma addizzjonali: Le

Irrevoka t-token · TokenRevokedData

TokenRevokedData · Ibgħat POST /api/v1/auth/revoke biċ-ċavetta li ħarġet it-token f’Authorization: ApiKey u t-token fil-qasam JSON access_token. Wara suċċess, l-użu li jmiss jirritorna 401. Token ripetut, mhux magħruf jew ta’ ħaddieħor jirċievi l-istess revoked: true; tokens ta’ ċwievet oħra ma jitħassrux.

revokedBooleanMhux obbligatorju: Ibgħat POST /api/v1/auth/revoke biċ-ċavetta li ħarġet it-token f’Authorization: ApiKey u t-token fil-qasam JSON access_token. Wara suċċess, l-użu li jmiss jirritorna 401. Token ripetut, mhux magħruf jew ta’ ħaddieħor jirċievi l-istess revoked: true; tokens ta’ ċwievet oħra ma jitħassrux.

const: true

Valur predefinit: trueEżempju: true

Oqsma addizzjonali: Le