| Sida | Använd den för att |
|---|---|
| Läs widgetreferensen | Läs widgetens attribut och tillåtna värden. |
| Lägg widgeten på en produktsida | En skripttagg. Produktmallen anger produktkoden. |
| Importera egna data | Skicka ett paket, kontrollera en provkörning och tillämpa det. |
01Skapa och kontrollera en API-nyckel
- Öppna Utvecklare i leverantörs- eller återförsäljaradmin.
- Skapa en nyckel med
api:readellerapi:write. - Spara hemligheten när den visas; listan visar bara maskerade nycklar.
- Förvara den på er server.
curl https://api.test.stockisto.com/api/public/v1/ping \
-H "Authorization: Bearer $STOCKISTO_API_KEY"
02Anropsgränser
| Gräns | Vad som gäller |
|---|---|
| Per API-nyckel | Standardgränsen är 300 anrop per minut och nyckel. |
| Anrop per månad | Er plan har också en månadskvot. Svaret 429 innehåller Retry-After. |
| Nyckelkontroll | Ping är undantaget från plankravet och månadskvoten; ett godkänt ping ger inte API-åtkomst. |
03Fel
Fel använder application/problem+json. 401 betyder saknad eller ogiltig nyckel, 403 otillräcklig behörighet. 402 anger funktionen som krävs. 429 innehåller Retry-After.
{
"title": "Payment Required",
"status": 402,
"feature_required": true,
"feature_key": "api.access"
}
04Sidor med resultat
Publika API-listor tar limit (1 till 200, standard 50) och cursor. Skicka svarets nextCursor som nästa anrops cursor tills värdet är null. Ändra inte markören. En felaktig markör ger 400.
curl 'https://api.test.stockisto.com/api/public/v1/stock?limit=1' \
-H "Authorization: Bearer $STOCKISTO_API_KEY"
{ "data": [], "nextCursor": null }
05Versioner
Versionen står i sökvägen: /api/public/v1. Läs ändringsloggen innan ni uppdaterar integrationen.
06TEST och produktion
Alla körbara exempel använder TEST. Använd adresserna i ert genererade kodavsnitt och nycklarna för rätt miljö. MCP i produktion startar vid lansering.
| Adress | TEST | Produktion |
|---|---|---|
| API | api.test.stockisto.com | api.stockisto.com |
| CDN | cdn.test.stockisto.com | cdn.stockisto.com |
| MCP | api.test.stockisto.com/mcp | Vid lansering |
07Widgetens kontrakt
-
Skriptet laddas asynkront i en Shadow DOM-värd.
-
Sparade widgetar hämtas före val av språk, form och datakälla.
-
Okända typer och vyer avvisas.
-
Startfel sätter
data-stockisto-errorpå skriptet. -
Utan datakälla blir värdet
missing-data-sourceoch inget visas. -
Ett dolt element hindrar värdens
div:emptyfrån att dölja widgeten. -
Analys skickas bara med
data-analytics-consent="true".
| Varumärkets widgetar | Butikens och installatörens widgetar |
|---|---|
where-to-buy | store-availability |
guided-handoff | store-card |
store-locator | stock-alert |
installer-finder | installer-card |
08Vilken inställning gäller
| Gräns | Vad som gäller |
|---|---|
| 1. Sidans attribut | Sidans uttryckliga attribut går före den sparade widgeten, sedan används standardvärden. Sidmallen anger produkt-, butiks- eller installatörsnycklar. |
| 2. Sparad widget | Widgetens id hämtar inställningarna som sparats i admin. |
| 3. Standardvärden | Utelämnade inställningar använder sparade värden, sedan widgetens standardvärden. |
09Testa svåra värdsidor
Prova en smal kolumn, laddning och en avvisad konfiguration med den riktiga widgeten.
Laddar