取得 · トークン — 認証
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
{
"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
完全なモデル: ApiResponse_TokenData_
dataTokenData必須成功レスポンスのデータ。
フィールド ·
dataaccess_token文字列必須短期間有効な Bearer 認証情報。
expires_at文字列必須認証情報の有効期限日時。
format:"date-time"expires_in整数任意認証情報の有効期間(秒)。
rate_limitsTokenRateLimitsData必須トークンの各応答には、発行時の店舗ポリシーに基づく data.rate_limits が含まれます。すべてのキーで上限を共有し、新しいトークンでもリセットされません。プラン変更はトークンの有効期限前に適用される場合があります。
フィールド ·
rate_limitsauth_per_minute整数必須認証失敗を含む、1分あたりのトークンリクエスト数。
minimum:0maximum:1000000read_per_minute整数必須1分あたりの読み取りリクエスト数。
minimum:0maximum:1000000write_per_minute整数必須1分あたりの書き込みリクエスト数。この値は書き込み権限を付与しません。
minimum:0maximum:1000000
token_type文字列任意返されたトークンの認証方式。
const:"Bearer"
metaContextPageMetaContextMetaPageMetaRequestMeta必須レスポンスのメタデータ。
フィールド ·
metalocale文字列必須このリクエストで選択した言語。
market_code文字列必須コンテキストエンドポイントが返した市場コード。
market_id文字列必須コンテキストエンドポイントが返した市場識別子。
paginationPagination必須カーソルによるページ分割のメタデータ。
request_id文字列必須申請識別子。レスポンスのメタデータでは HTTP リクエストを識別します。
minLength:1maxLength:100
locale文字列必須このリクエストで選択した言語。
market_code文字列必須コンテキストエンドポイントが返した市場コード。
market_id文字列必須コンテキストエンドポイントが返した市場識別子。
request_id文字列必須申請識別子。レスポンスのメタデータでは HTTP リクエストを識別します。
minLength:1maxLength:100
paginationPagination必須カーソルによるページ分割のメタデータ。
request_id文字列必須申請識別子。レスポンスのメタデータでは HTTP リクエストを識別します。
minLength:1maxLength:100
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