Referens för widget och API

Utvecklardokumentation: alla sidor

Börja

Hjälp och dokumentation

Ändringar

SidaAnvänd den för att
Läs widgetreferensenLäs widgetens attribut och tillåtna värden.
Lägg widgeten på en produktsidaEn skripttagg. Produktmallen anger produktkoden.
Importera egna dataSkicka ett paket, kontrollera en provkörning och tillämpa det.

01Skapa och kontrollera en API-nyckel

  1. Öppna Utvecklare i leverantörs- eller återförsäljaradmin.
  2. Skapa en nyckel med api:read eller api:write.
  3. Spara hemligheten när den visas; listan visar bara maskerade nycklar.
  4. Förvara den på er server.
curl https://api.test.stockisto.com/api/public/v1/ping \
  -H "Authorization: Bearer $STOCKISTO_API_KEY"

OpenAPI JSON · Scalar

02Anropsgränser

GränsVad som gäller
Per API-nyckelStandardgränsen är 300 anrop per minut och nyckel.
Anrop per månadEr plan har också en månadskvot. Svaret 429 innehåller Retry-After.
NyckelkontrollPing ä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.

AdressTESTProduktion
APIapi.test.stockisto.comapi.stockisto.com
CDNcdn.test.stockisto.comcdn.stockisto.com
MCPapi.test.stockisto.com/mcpVid 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-error på skriptet.

  • Utan datakälla blir värdet missing-data-source och inget visas.

  • Ett dolt element hindrar värdens div:empty från att dölja widgeten.

  • Analys skickas bara med data-analytics-consent="true".

Varumärkets widgetarButikens och installatörens widgetar
where-to-buystore-availability
guided-handoffstore-card
store-locatorstock-alert
installer-finderinstaller-card

08Vilken inställning gäller

GränsVad som gäller
1. Sidans attributSidans uttryckliga attribut går före den sparade widgeten, sedan används standardvärden. Sidmallen anger produkt-, butiks- eller installatörsnycklar.
2. Sparad widgetWidgetens id hämtar inställningarna som sparats i admin.
3. StandardvärdenUtelä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