Publika API:er

En översikt över det publika API:et – vad det kan göra, hur du autentiserar och vilka gränser för antal anrop som gäller.

1. API:ets användningsområde

a. Funktioner som stöds via API:et

Det publika API:et ger åtkomst till de viktigaste funktionerna i Wholesale-appen, bland annat:

Kärnfunktioner: Wholesale Pricing, Volume Pricing, Registration form, Quick Order Form, Quick Buy Collection, Quick Buy Variant
Tilläggsfunktioner: Order Limit, Shipping Rate, Extra Fee, Payment Term (kommer snart)

b. Metoder som stöds

API:et stöder fullständiga CRUD-operationer med följande HTTP-metoder:

GET – hämta data
POST – skapa ny data
PUT – uppdatera befintlig data
DELETE – ta bort data

API-nycklar kan få följande behörighetsnivåer: Read Only/Write Only, Read & Write

Åtgärder som stöds: Get list - Get item - Create item - Update item - Delete item

c. Shopify-planer som stöds:

Wholesale-appens publika API är tillgängligt för Shopify-butiker som uppfyller följande krav:

Måste vara en produktionsbutik (gäller inte utvecklings- eller testbutiker)
Måste ha Gold-planen

2. Autentisering

Alla API-anrop måste vara korrekt autentiserade innan de behandlas.

a. Obligatoriska parametrar

Varje API-anrop måste innehålla följande obligatoriska parametrar:

Parameter	Beskrivning
`shop`	Shopify-butikens domän (t.ex. mystore.myshopify.com)
`api_key`	API-nyckel som genererats i Wholesale-appen

Om någon av dessa parametrar saknas avvisas anropet.

b. Hantera API-nycklar

API-nycklar skapas och hanteras direkt i Wholesale-appens administrationsgränssnitt.
Butiksägare kan ställa in specifika behörigheter för varje API-nyckel: Read only/Write only, Read & Write

3. API-struktur och svarsformat

a. API-endpoint

Alla API-anrop ska använda följande bas-URL:

https://wholesale.samita.io/v1/

b. Funktionsspecifika endpoints

Varje funktionsgrupp har sin egen endpoint. Till exempel:

Wholesale-funktionen:

https://wholesale.samita.io/v1/wholesale/

Volume Pricing-funktionen:
```
https://wholesale.samita.io/v1/volume/
```

(De faktiska endpoints kan variera beroende på funktionen.)

c. Query-parametrar som stöds

API:et stöder flera vanliga query-parametrar:

Parameter	Beskrivning
`status`	Status för posterna
`page`	Sidnummer för paginering
`limit`	Antal poster per sida
`sort`	Sorteringskriterier
`query`	Sök- eller filtervillkor

Exempelanrop:

GET /wholesale?page=1&limit=20&sort=created_at

4. Svarskoder

Varje API-anrop returnerar någon av följande statuskoder:

a. Vanliga felsvar

401 – Unauthorized

Möjliga orsaker:

Butikens URL saknas
API-nyckel saknas
Ogiltig butiks-URL
Ogiltig API-nyckel
API-nyckeln matchar inte butiken

403 – This action is unauthorized

API-nyckeln har inte behörighet att utföra den begärda åtgärden
Otillräckliga behörigheter för View / Create / Update / Delete

429 – Too Many Requests

Gränsen för antal anrop har överskridits
Frekvensen på API-anrop överskrider den tillåtna gränsen

b. Lyckat svar

200 – Success

Anropet är giltigt
API-åtgärden utfördes
Data returneras i korrekt format

5. Gräns för antal anrop

För att säkerställa systemets prestanda och stabilitet gäller en daglig gräns för antal anrop. Det finns ingen längre begränsning per anrop eller korta intervall – du kan anropa API:et så ofta du vill så länge du håller dig inom din plans dagskvot.

Dagsgränsen beror på butikens prisplan:

Plan	Daglig anropsgräns
Free	5 anrop/dag
Starter	50 anrop/dag
Growth	250 anrop/dag
Enterprise	500 anrop/dag

Den dagliga räknaren nollställs varje dag vid midnatt (servertid).

Om dagsgränsen överskrids returnerar systemet:

429 – Too Many Requests

{
  "message": "Daily request limit exceeded (X requests/day)."
}

Var det här till hjälp?