데이터 스키마: 인증

dataTokenData 필수

응답 예제 · TokenData.

예제: {"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 필수

응답 메타데이터입니다.

예제: {"request_id":"example"}

추가 필드: 아니요

dataTokenRevokedData 필수

응답 예제 · TokenRevokedData.

예제: {"revoked":true}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 필수

응답 메타데이터입니다.

예제: {"request_id":"example-request"}

추가 필드: 아니요

access_token문자열필수

Authorization: Bearer 헤더에 사용할 토큰입니다. 별도 예제를 실행하기 전에 SHOPENTLY_ACCESS_TOKEN을 설정하세요.

예제: "EXAMPLE_ACCESS_TOKEN"

expires_at문자열필수

UTC 기준 만료 시각입니다. 현재 접근 제한에 따라 그 전에 토큰이 차단될 수 있습니다.

format: "date-time"

예제: "2026-01-01T12:15:00Z"

expires_in정수필수

실제 유효 기간(초)이며 이 예제는 1800을 요청합니다. 요청으로 연장되지 않습니다. expires_at은 UTC 만료 시각입니다.

minimum: 300maximum: 3600

예제: 1800

permissions배열 <문자열> 필수

permissions는 현재 유효한 권한으로, 키·작성자·스토어 요금제 권한의 교집합이며 활성 애드온 권한도 포함합니다. 요청마다 접근 권한을 다시 확인합니다.

예제: ["orders.order:read"]

rate_limitsTokenRateLimitsData 필수

Engine ≥ 4.143.0. 각 토큰 응답에는 발급 당시 스토어 정책의 data.rate_limits가 포함됩니다. 모든 키가 이 한도를 공유하며 새 토큰을 받아도 초기화되지 않습니다. 요금제 변경은 토큰 만료 전에 적용될 수 있습니다.

예제: {"auth_per_minute":1,"read_per_minute":2,"write_per_minute":15}

token_type문자열선택 사항

Bearer. 반환한 토큰에 사용하는 인증 방식입니다.

const: "Bearer"

기본값: "Bearer"예제: "Bearer"

warnings배열 <TokenLifetimeWarning > 필수

범위를 벗어난 정수는 900초를 적용하고 token.ttl_out_of_range 및 learn.shopently.com의 documentation_url을 warnings로 반환합니다. 생략하면 경고가 없고 잘못된 유형은 422를 반환합니다.

예제: []

추가 필드: 아니요

applied_seconds정수선택 사항

900 s (15 min)

기본값: 900

code문자열선택 사항

token.ttl_out_of_range

const: "token.ttl_out_of_range"

기본값: "token.ttl_out_of_range"

documentation_url문자열선택 사항

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

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

field문자열선택 사항

ttl_seconds

const: "ttl_seconds"

기본값: "ttl_seconds"

max_seconds정수선택 사항

3600 s (60 min)

기본값: 3600

message문자열선택 사항

범위를 벗어난 정수는 900초를 적용하고 token.ttl_out_of_range 및 learn.shopently.com의 documentation_url을 warnings로 반환합니다. 생략하면 경고가 없고 잘못된 유형은 422를 반환합니다.

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

min_seconds정수선택 사항

300 s (5 min)

기본값: 300

추가 필드: 아니요

auth_per_minute정수필수

인증 실패를 포함한 분당 토큰 발급 및 취소 요청 수입니다. 두 작업은 auth 한도를 공유합니다.

minimum: 0maximum: 1000000

예제: 1

read_per_minute정수필수

분당 읽기 요청 수입니다.

minimum: 0maximum: 1000000

예제: 2

write_per_minute정수필수

분당 쓰기 요청 수입니다. 이 값은 쓰기 권한을 부여하지 않습니다.

minimum: 0maximum: 1000000

예제: 15

추가 필드: 아니요

ttl_seconds정수선택 사항

선택적 정수 ttl_seconds: 300–3600초(5–60분). 생략하면 기본값은 900초(15분)입니다.

기본값: 900예제: 1800

추가 필드: 아니요

access_token문자열필수

POST /api/v1/auth/revoke 요청에 발급 키를 Authorization: ApiKey로, 토큰을 JSON access_token 필드로 보냅니다. 성공 후 다음 사용은 401을 반환합니다. 반복되거나 알 수 없거나 다른 키의 토큰도 동일한 revoked: true를 반환하며 다른 키의 토큰은 삭제하지 않습니다.

minLength: 1maxLength: 256

예제: "shpt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

추가 필드: 아니요

revoked불리언선택 사항

POST /api/v1/auth/revoke 요청에 발급 키를 Authorization: ApiKey로, 토큰을 JSON access_token 필드로 보냅니다. 성공 후 다음 사용은 401을 반환합니다. 반복되거나 알 수 없거나 다른 키의 토큰도 동일한 revoked: true를 반환하며 다른 키의 토큰은 삭제하지 않습니다.

const: true

기본값: true예제: true

추가 필드: 아니요