Scéimeanna sonraí: Fíordheimhniú

dataTokenData Riachtanach

Sampla freagra · TokenData.

Sampla: {"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 Riachtanach

Meiteashonraí an fhreagra.

Sampla: {"request_id":"example"}

Réimsí breise: Níl

dataTokenRevokedData Riachtanach

Sampla freagra · TokenRevokedData.

Sampla: {"revoked":true}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Riachtanach

Meiteashonraí an fhreagra.

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

Réimsí breise: Níl

access_tokenTeaghránRiachtanach

Comhartha don cheanntásc Authorization: Bearer. Socraigh SHOPENTLY_ACCESS_TOKEN sula ritheann tú an sampla ar leith.

Sampla: "EXAMPLE_ACCESS_TOKEN"

expires_atTeaghránRiachtanach

Am éaga in UTC. Féadfaidh na srianta rochtana reatha an comhartha a bhlocáil níos luaithe.

format: "date-time"

Sampla: "2026-01-01T12:15:00Z"

expires_inSlánuimhirRiachtanach

An tréimhse bhailíochta iarbhír i soicindí; iarrann an sampla seo 1800. Ní shíneann iarratais í. Is é expires_at an t-am éaga in UTC.

minimum: 300maximum: 3600

Sampla: 1800

permissionsEagar <Teaghrán> Riachtanach

Taispeánann permissions na ceadanna éifeachtacha reatha: an trasnú idir ceadanna na heochrach, a húdair agus phlean an tsiopa, lena n-áirítear breiseáin ghníomhacha. Seiceáiltear rochtain arís le gach iarratas.

Sampla: ["orders.order:read"]

rate_limitsTokenRateLimitsData Riachtanach

Engine ≥ 4.143.0. Áirítear data.rate_limits ó pholasaí an tsiopa tráth a eisiúna i ngach freagra comhartha. Roinneann gach eochair na teorainneacha seo; ní athshocraíonn comhartha nua iad. D’fhéadfadh athrú plean teacht i bhfeidhm sula dtéann an comhartha in éag.

Sampla: {"auth_per_minute":1,"read_per_minute":2,"write_per_minute":15}

token_typeTeaghránRoghnach

Bearer. Scéim fíordheimhnithe an chomhartha a thugtar ar ais.

const: "Bearer"

Réamhshocrú: "Bearer"Sampla: "Bearer"

warningsEagar <TokenLifetimeWarning > Riachtanach

Cuireann slánuimhir lasmuigh den raon 900 soicind i bhfeidhm agus seolann sí warnings le token.ttl_out_of_range agus documentation_url chuig learn.shopently.com. Ní chruthaíonn réimse ar iarraidh rabhadh; tugann cineál neamhbhailí 422.

Sampla: []

Réimsí breise: Níl

applied_secondsSlánuimhirRoghnach

900 s (15 min)

Réamhshocrú: 900

codeTeaghránRoghnach

token.ttl_out_of_range

const: "token.ttl_out_of_range"

Réamhshocrú: "token.ttl_out_of_range"

documentation_urlTeaghránRoghnach

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

Réamhshocrú: "https://learn.shopently.com/en/api/docs/authentication/#token-lifetime"

fieldTeaghránRoghnach

ttl_seconds

const: "ttl_seconds"

Réamhshocrú: "ttl_seconds"

max_secondsSlánuimhirRoghnach

3600 s (60 min)

Réamhshocrú: 3600

messageTeaghránRoghnach

Cuireann slánuimhir lasmuigh den raon 900 soicind i bhfeidhm agus seolann sí warnings le token.ttl_out_of_range agus documentation_url chuig learn.shopently.com. Ní chruthaíonn réimse ar iarraidh rabhadh; tugann cineál neamhbhailí 422.

Réamhshocrú: "ttl_seconds must be between 300 and 3600 seconds. The default lifetime of 900 seconds was applied."

min_secondsSlánuimhirRoghnach

300 s (5 min)

Réamhshocrú: 300

Réimsí breise: Níl

auth_per_minuteSlánuimhirRiachtanach

Iarratais eisiúna agus cúlghairme in aghaidh an nóiméid, lena n-áirítear fíordheimhniú teipthe. Roinneann an dá oibríocht teorainn auth.

minimum: 0maximum: 1000000

Sampla: 1

read_per_minuteSlánuimhirRiachtanach

Iarratais léitheoireachta sa nóiméad.

minimum: 0maximum: 1000000

Sampla: 2

write_per_minuteSlánuimhirRiachtanach

Iarratais scríbhneoireachta sa nóiméad; ní thugann an luach seo cead scríbhneoireachta.

minimum: 0maximum: 1000000

Sampla: 15

Réimsí breise: Níl

ttl_secondsSlánuimhirRoghnach

Slánuimhir roghnach ttl_seconds: 300–3600 soicind (5–60 nóiméad). Mura seoltar an réimse, is é 900 soicind (15 nóiméad) an réamhshocrú.

Réamhshocrú: 900Sampla: 1800

Réimsí breise: Níl

access_tokenTeaghránRiachtanach

Seol POST /api/v1/auth/revoke leis an eochair eisiúna in Authorization: ApiKey agus an comhartha sa réimse JSON access_token. Tar éis ratha, tugann an chéad úsáid eile 401. Faigheann comhartha athsheolta, anaithnid nó eachtrach an revoked: true céanna; ní scriostar comharthaí eochracha eile.

minLength: 1maxLength: 256

Sampla: "shpt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Réimsí breise: Níl

revokedLuach BooleRoghnach

Seol POST /api/v1/auth/revoke leis an eochair eisiúna in Authorization: ApiKey agus an comhartha sa réimse JSON access_token. Tar éis ratha, tugann an chéad úsáid eile 401. Faigheann comhartha athsheolta, anaithnid nó eachtrach an revoked: true céanna; ní scriostar comharthaí eochracha eile.

const: true

Réamhshocrú: trueSampla: true

Réimsí breise: Níl