01Autentisering
- Behörighet
api:read- Header
Authorization: Bearer YOUR_API_KEYellerX-API-Key: YOUR_API_KEY- Plan
Er plan måste omfatta API-åtkomst. Nyckeln knyter anropet till ert konto.
02Frågeparametrar
| Parameter | Beteende |
|---|---|
limit | Standardvärde 50. Värden begränsas till 1 till 200. |
cursor | Skicka föregående svars nextCursor oförändrat. Utelämna det på första sidan. En felaktig markör ger 400. |
03Anrop
curl "https://api.test.stockisto.com/api/public/v1/retailers?limit=50" \
-H "Authorization: Bearer $STOCKISTO_API_KEY"
04Svar
Ett varumärke ser aktiva anslutna återförsäljare med en tillåten, offentligt synlig plats. En återförsäljare ser sin egen aktiva post. Resultaten sorteras efter återförsäljar-id. Fortsätt tills nextCursor är null. Ett 200-svar har följande format; data innehåller tillgängliga poster:
{ "data": [], "nextCursor": null }
| Fält | Typ och betydelse |
|---|---|
data[].id | UUID. Återförsäljarens id. |
data[].name | Sträng. Återförsäljarens namn. |
data[].website | Sträng eller null. |
data[].city | Sträng eller null. |
data[].country | Sträng eller null. |
nextCursor | Opak sträng eller null. Skicka tillbaka som cursor. |
GET /api/public/v1/locations använder samma sidindelning och nyckel. Svaret innehåller synliga platser: id, retailerId, adress, kontaktuppgifter, koordinater och öppettider. Leverantörers resultat följer även relationens landsbegränsningar.
curl "https://api.test.stockisto.com/api/public/v1/locations?limit=50" \
-H "Authorization: Bearer $STOCKISTO_API_KEY"
05Fel och gränser
| Svar | Nästa steg |
|---|---|
| 400 | Använd exakt det nextCursor som returnerades. |
| 401 | Kontrollera giltighet och återkallelse. Prova nyckeln med /api/public/v1/ping. |
402 | Läs feature_key i svaret och välj en plan med funktionen på Priser. Priser |
| 403 | Använd en nyckel med api:read. |
| 429 | Vänta enligt Retry-After; kontrollera anropsgränsen och månadskvoten. |
| 503 | Gränskontrollen är otillgänglig. Försök efter Retry-After. |
Standardgränsen är 300 anrop per minut och nyckel. Globala gränser och månadskvoten gäller också. Be oss höja nyckelns gräns.