Hae · Tunniste — Todentaminen
Hae 900 sekuntia voimassa oleva Shopently API -tunniste. Tutustu ApiKey-otsakkeeseen, vastaukseen ja Bearerin käyttöön seuraavissa pyynnöissä.
POST/api/v1/auth/token
- Todentaminen
ApiKey- Saatavilla alkaen
- BASIC
- Vaaditut käyttöoikeudet
- Ei sovellu
Koodiesimerkit
Pyyntöesimerkki
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))
Vastausesimerkki 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"
}
}
Todentaminen
- API-avain lähetetään vain POST /api/v1/auth/token -pyynnön Authorization-otsakkeessa.
- Älä lisää sitä JSON-sisältöön, URL-osoitteeseen tai kyselyparametreihin.
- Käytä palautettua tunnusta resurssipyyntöihin ja uusi se expires_at-arvon mukaan.
- expires_in ilmaistaan sekunteina.
- Käyttöoikeustunnus ei ohita avaimen nykyisiä käyttöoikeuksia, kaupan pakettioikeuksia, peruutusta tai IP-rajoituksia.
Kuinka kauan tunniste on voimassa?
- expires_in: 900 sekuntia eli 15 minuuttia myöntämisestä. Pyyntöjen tekeminen ei pidennä voimassaoloa.
- expires_at: Vanhenemisajankohta UTC-ajassa. Nykyiset käyttörajoitukset voivat estää tunnisteen käytön jo aiemmin.
Käytä samaa tunnistetta useisiin pyyntöihin ja hae uusi ennen expires_at-ajankohtaa. Älä hae tunnistetta ennen jokaista toimintoa. Käytä uuden tunnisteen hakemiseen API-avainta.
Pyyntörajat
Engine ≥ 4.143.0. Jokainen tokenvastaus sisältää myöntämishetken kauppakäytännön data.rate_limits-arvot. Kaikki avaimet jakavat nämä kiintiöt; uusi token ei nollaa niitä. Tilausmuutos voi tulla voimaan ennen tokenin vanhenemista.
Parametrit
Ei polku-, kysely- tai lisäotsakeparametreja.
Pyynnön sisältö
application/json · Valinnainen
TokenRequest
null
Vastaukset
Vastaus 200
Koko malli: ApiResponse_TokenData_
dataTokenDataPakollinenOnnistuneen vastauksen sisältö.
Kentät ·
dataaccess_tokenMerkkijonoPakollinenLyhytikäinen Bearer-käyttöoikeustunnus.
expires_atMerkkijonoPakollinenKäyttöoikeustunnuksen vanhenemispäivä ja -aika.
format:"date-time"expires_inKokonaislukuValinnainenKäyttöoikeustunnuksen voimassaoloaika sekunteina.
rate_limitsTokenRateLimitsDataPakollinenJokainen tokenvastaus sisältää myöntämishetken kauppakäytännön data.rate_limits-arvot. Kaikki avaimet jakavat nämä kiintiöt; uusi token ei nollaa niitä. Tilausmuutos voi tulla voimaan ennen tokenin vanhenemista.
Kentät ·
rate_limitsKoko malli:
TokenRateLimitsDataauth_per_minuteKokonaislukuPakollinenTokenpyyntöjä minuutissa, mukaan lukien epäonnistuneet tunnistautumisyritykset.
minimum:0maximum:1000000read_per_minuteKokonaislukuPakollinenLukupyyntöjä minuutissa.
minimum:0maximum:1000000write_per_minuteKokonaislukuPakollinenKirjoituspyyntöjä minuutissa; arvo ei myönnä kirjoitusoikeuksia.
minimum:0maximum:1000000
token_typeMerkkijonoValinnainenPalautetun tunnuksen todentamismenetelmä.
const:"Bearer"
metaContextPageMetaContextMetaPageMetaRequestMetaPakollinenVastauksen metatiedot.
Kentät ·
metalocaleMerkkijonoPakollinenTälle pyynnölle valittu kieli.
market_codeMerkkijonoPakollinenKontekstipäätepisteen palauttama markkinakoodi.
market_idMerkkijonoPakollinenKontekstipäätepisteen palauttama markkinatunniste.
paginationPaginationPakollinenKohdistinpohjaisen sivutuksen metatiedot.
request_idMerkkijonoPakollinenTapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.
minLength:1maxLength:100
localeMerkkijonoPakollinenTälle pyynnölle valittu kieli.
market_codeMerkkijonoPakollinenKontekstipäätepisteen palauttama markkinakoodi.
market_idMerkkijonoPakollinenKontekstipäätepisteen palauttama markkinatunniste.
request_idMerkkijonoPakollinenTapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.
minLength:1maxLength:100
paginationPaginationPakollinenKohdistinpohjaisen sivutuksen metatiedot.
request_idMerkkijonoPakollinenTapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.
minLength:1maxLength:100
request_idMerkkijonoPakollinenTapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.
minLength:1maxLength:100
HTTP-tilakoodi
200- Onnistunut vastaus Skeema
400- Virheellinen pyyntö
401- Tunnistautuminen vaaditaan
403- Pääsy estetty
404- Resurssia ei löydy
409- Versioristiriita
422- Validointi epäonnistui
429- Pyyntöraja ylitetty
Muut HTTP-tilat (7)
405- Menetelmä ei ole sallittu
413- Pyyntö on liian suuri
415- Muotoa ei tueta
500- Palvelinvirhe
502- API-yhdyskäytävän virhe
503- Palvelu ei ole käytettävissä
504- Aikakatkaisu
Virheluettelo: ErrorResponse
Otsakkeet
401
WWW-AuthenticateMerkkijonoValinnainenPalvelimen vaatima todentamismenetelmä.
405
AllowMerkkijonoValinnainenTämän resurssin tukemat HTTP-metodit.
429, 503
Retry-AfterKokonaislukuValinnainenVähimmäisviive ennen uudelleenyritystä sekunteina.
minimum:0.0