콘텐츠로 건너뛰기
ShopentlyLearn

조회 · 토큰 — 인증

900초 동안 유효한 Shopently API 토큰을 받으세요. ApiKey 헤더, 응답 및 이후 요청에서의 Bearer 사용법을 확인하세요.

POST/api/v1/auth/token

인증
ApiKey
최소 요금제
BASIC
필수 권한
해당 없음

코드 예제

요청 예제

cURL

: "${SHOPENTLY_SHOP_URL:?}"

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request POST \
  --header "Authorization: ApiKey ${SHOPENTLY_API_KEY:?}" \
  --header 'Content-Type: application/json' \
  --data-raw '{}' \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/auth/token

PHP

<?php
declare(strict_types=1);

$baseUrl = rtrim(getenv('SHOPENTLY_SHOP_URL') ?: '', '/');
$origin = parse_url($baseUrl);
if (!$origin || ($origin['scheme'] ?? '') !== 'https' || empty($origin['host']) ||
    isset($origin['user'], $origin['pass']) || isset($origin['user']) || isset($origin['path']) ||
    isset($origin['query']) || isset($origin['fragment'])) {
    throw new RuntimeException('SHOPENTLY_SHOP_URL must be an HTTPS origin');
}
$credential = getenv('SHOPENTLY_API_KEY') ?: '';
if ($credential === '' || strpbrk($credential, "\r\n") !== false) {
    throw new RuntimeException('Invalid credential');
}
$headers = ['Content-Type: application/json'];
$headers[] = 'Authorization: ApiKey ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/auth/token');
curl_setopt_array($handle, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_FOLLOWLOCATION => false,
    CURLOPT_PROTOCOLS => CURLPROTO_HTTPS,
    CURLOPT_SSL_VERIFYPEER => true,
    CURLOPT_SSL_VERIFYHOST => 2,
    CURLOPT_CONNECTTIMEOUT => 5,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HEADERFUNCTION => static function ($handle, string $line) use (&$responseHeaders): int {
        if (str_contains($line, ':')) {
            [$name, $value] = explode(':', $line, 2);
            $responseHeaders[strtolower(trim($name))] = trim($value);
        }
        return strlen($line);
    },
]);
curl_setopt($handle, CURLOPT_POSTFIELDS, '{}');
$raw = curl_exec($handle);
$status = curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
$error = curl_error($handle);
curl_close($handle);
if ($raw === false) {
    throw new RuntimeException('Transport error: ' . $error);
}
if ($status < 200 || $status >= 300) {
    throw new RuntimeException('HTTP ' . $status . '; request_id=' .
        ($responseHeaders['x-request-id'] ?? '') . '; retry_after=' . ($responseHeaders['retry-after'] ?? ''));
}
$result = $raw === '' ? null : json_decode($raw, true, 512, JSON_THROW_ON_ERROR | JSON_BIGINT_AS_STRING);
echo json_encode($result, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE), PHP_EOL;

Python

from contextlib import ExitStack
import json
import os
from urllib.parse import urlsplit

import requests  # python -m pip install requests

base_url = os.environ["SHOPENTLY_SHOP_URL"].rstrip("/")
origin = urlsplit(base_url)
if origin.scheme != "https" or not origin.hostname or origin.username or origin.password or origin.path or origin.query or origin.fragment:
    raise ValueError("SHOPENTLY_SHOP_URL must be an HTTPS origin")
credential = os.environ['SHOPENTLY_API_KEY']
if not credential or "\r" in credential or "\n" in credential:
    raise ValueError("Invalid credential")
headers = {}
headers["Authorization"] = 'ApiKey' + " " + credential
body = '{}'
if body is not None:
    headers["Content-Type"] = "application/json"

with ExitStack() as stack:
    session = stack.enter_context(requests.Session())
    files = None
    if False:
        image = stack.enter_context(open(os.environ["SHOPENTLY_IMAGE_FILE"], "rb"))
        if os.fstat(image.fileno()).st_size > 5242880:
            raise ValueError("Image exceeds 5 MiB")
        files = {"file": ("article.png", image, "image/png")}
    response = session.request(
        'POST', base_url + '/api/v1/auth/token', headers=headers,
        data=body.encode("utf-8") if body is not None else None, files=files,
        timeout=(5, 30), allow_redirects=False,
    )
    if not 200 <= response.status_code < 300:
        raise RuntimeError(f"HTTP {response.status_code}; request_id={response.headers.get('X-Request-ID', '')}; retry_after={response.headers.get('Retry-After', '')}")
    if False:
        if response.headers.get("Content-Type") != "image/webp" or len(response.content) > 5242880:
            raise ValueError("Unexpected image response")
        with open(os.environ["SHOPENTLY_OUTPUT_FILE"], "xb") as output:
            output.write(response.content)
    else:
        result = response.json() if response.content else None
        print(json.dumps(result, ensure_ascii=False, indent=2))

응답 예제 200

JSON
{
  "data": {
    "access_token": "EXAMPLE_ACCESS_TOKEN",
    "expires_at": "2026-01-01T12:00:00Z",
    "expires_in": 900,
    "rate_limits": {
      "auth_per_minute": 10,
      "read_per_minute": 60,
      "write_per_minute": 10
    },
    "token_type": "Bearer"
  },
  "meta": {
    "request_id": "example"
  }
}

인증

  • API 키는 POST /api/v1/auth/token 의 Authorization 헤더에만 전송합니다.
  • JSON, URL, 쿼리 매개변수에 넣지 마세요.
  • 리소스 요청에는 반환된 토큰을 사용하고 expires_at 에 따라 갱신하세요.
  • expires_in 의 단위는 초입니다.
  • 액세스 토큰으로도 키의 현재 권한, 스토어 이용 권한, 폐기 상태 또는 IP 제한을 우회할 수 없습니다.

토큰은 얼마나 유효한가요?

  • expires_in: 발급 시점부터 900초, 즉 15분입니다. 요청을 보내도 유효 기간은 연장되지 않습니다.
  • expires_at: UTC 기준 만료 시각입니다. 현재 접근 제한에 따라 그 전에 토큰이 차단될 수 있습니다.

같은 토큰을 여러 요청에 재사용하고 expires_at 이전에 새 토큰을 받으세요. 작업마다 토큰을 받을 필요는 없습니다. 새 토큰을 받으려면 API 키를 사용하세요.

요청 속도 제한

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

매개변수

경로, 쿼리 또는 추가 헤더 매개변수가 없습니다.

요청 본문

application/json · 선택 사항

TokenRequest null

응답

응답 200

dataTokenData 필수

성공 응답의 데이터입니다.

필드 · data
access_token문자열필수

유효 기간이 짧은 Bearer 인증 정보입니다.

expires_at문자열필수

인증 정보가 만료되는 날짜와 시각입니다.

format: "date-time"
expires_in정수선택 사항

인증 정보의 유효 기간(초)입니다.

기본값: 900

rate_limitsTokenRateLimitsData 필수

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

필드 · rate_limits
auth_per_minute정수필수

인증 실패를 포함한 분당 토큰 요청 수입니다.

minimum: 0maximum: 1000000
read_per_minute정수필수

분당 읽기 요청 수입니다.

minimum: 0maximum: 1000000
write_per_minute정수필수

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

minimum: 0maximum: 1000000
token_type문자열선택 사항

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

const: "Bearer"

기본값: "Bearer"

metaContextPageMeta ContextMeta PageMeta RequestMeta 필수

응답 메타데이터입니다.

필드 · meta

ContextPageMeta

locale문자열필수

이 요청에서 선택한 언어입니다.

market_code문자열필수

컨텍스트 엔드포인트가 반환한 시장 코드입니다.

market_id문자열필수

컨텍스트 엔드포인트가 반환한 시장 식별자입니다.

paginationPagination 필수

커서 기반 페이지 나누기 메타데이터입니다.

request_id문자열필수

고객 요청 식별자이며 응답 메타데이터에서는 HTTP 요청을 식별합니다.

minLength: 1maxLength: 100

ContextMeta

locale문자열필수

이 요청에서 선택한 언어입니다.

market_code문자열필수

컨텍스트 엔드포인트가 반환한 시장 코드입니다.

market_id문자열필수

컨텍스트 엔드포인트가 반환한 시장 식별자입니다.

request_id문자열필수

고객 요청 식별자이며 응답 메타데이터에서는 HTTP 요청을 식별합니다.

minLength: 1maxLength: 100

PageMeta

paginationPagination 필수

커서 기반 페이지 나누기 메타데이터입니다.

request_id문자열필수

고객 요청 식별자이며 응답 메타데이터에서는 HTTP 요청을 식별합니다.

minLength: 1maxLength: 100

RequestMeta

request_id문자열필수

고객 요청 식별자이며 응답 메타데이터에서는 HTTP 요청을 식별합니다.

minLength: 1maxLength: 100
응답 예제

HTTP 상태

200
성공 응답 스키마
400
잘못된 요청
401
인증 필요
403
권한 없음
404
리소스를 찾을 수 없음
409
버전 충돌
422
유효성 검사 실패
429
요청 한도 초과
기타 HTTP 상태 (7)
405
허용되지 않은 메서드
413
요청이 너무 큼
415
지원하지 않는 형식
500
서버 오류
502
API 게이트웨이 오류
503
서비스 이용 불가
504
시간 초과

오류 목록: ErrorResponse

헤더

401

WWW-Authenticate문자열선택 사항

서버가 요구하는 인증 방식입니다.

405

Allow문자열선택 사항

이 리소스가 지원하는 HTTP 메서드입니다.

429, 503

Retry-After정수선택 사항

재시도 전에 기다려야 하는 최소 시간(초)입니다.

minimum: 0.0