Public API's

Een overzicht van de Public API: wat je ermee kunt doen, hoe je authenticeert en welke limieten gelden.

1. Gebruiksbereik van de API

a. Ondersteunde functies via de API

Met de Public API kun je werken met de belangrijkste functies van de Wholesale-app, waaronder:

Kernfuncties: Wholesale Pricing, Volume Pricing, Registration form, Quick Order Form, Quick Buy Collection, Quick Buy Variant
Add-on-functies: Order Limit, Shipping Rate, Extra Fee, Payment Term (binnenkort beschikbaar)

b. Ondersteunde methoden

De API ondersteunt alle CRUD-bewerkingen met de volgende HTTP-methoden:

GET – Gegevens ophalen
POST – Nieuwe gegevens aanmaken
PUT – Bestaande gegevens bijwerken
DELETE – Gegevens verwijderen

API-sleutels kunnen de volgende rechtenniveaus krijgen: Read Only/Write Only, Read & Write

Ondersteunde acties zijn onder meer: Get list - Get item - Create item - Update item - Delete item

c. Ondersteunde Shopify-abonnementen:

De Public API van de Wholesale-app is beschikbaar voor Shopify-winkels die aan de volgende voorwaarden voldoen:

Het moet een productiewinkel zijn (niet beschikbaar voor ontwikkel- of testwinkels)
Het Gold-abonnement moet actief zijn

2. Authenticatie

Alle API-verzoeken moeten correct zijn geauthenticeerd voordat ze worden verwerkt.

a. Vereiste parameters

Elk API-verzoek moet de volgende verplichte parameters bevatten:

Parameter	Beschrijving
`shop`	Shopify-shopdomein (bijv. mystore.myshopify.com)
`api_key`	API-sleutel die in de Wholesale-app is gegenereerd

Als een van deze parameters ontbreekt, wordt het verzoek geweigerd.

b. Beheer van API-sleutels

API-sleutels maak en beheer je rechtstreeks in de beheerinterface van de Wholesale-app.
Winkeleigenaren kunnen voor elke API-sleutel specifieke rechten instellen: Read only/Write only, Read & Write

3. API-structuur en responsindeling

a. API-endpoint

Alle API-verzoeken gebruiken de volgende basis-URL:

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

b. Endpoints per functie

Elke functiegroep heeft een eigen endpoint. Bijvoorbeeld:

Wholesale-functie:

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

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

(De daadwerkelijke endpoints kunnen verschillen, afhankelijk van de specifieke functionaliteit.)

c. Ondersteunde queryparameters

De API ondersteunt een aantal veelgebruikte queryparameters:

Parameter	Beschrijving
`status`	Status van de records
`page`	Paginanummer voor paginering
`limit`	Aantal records per pagina
`sort`	Sorteercriteria
`query`	Zoek- of filtervoorwaarde

Voorbeeldverzoek:

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

4. Responscodes

Elk API-verzoek geeft een van de volgende statuscodes terug:

a. Veelvoorkomende foutresponsen

401 – Unauthorized

Mogelijke oorzaken:

Shop-URL ontbreekt
API-sleutel ontbreekt
Ongeldige shop-URL
Ongeldige API-sleutel
API-sleutel hoort niet bij de shop

403 – This action is unauthorized

De API-sleutel heeft geen toestemming om de gevraagde actie uit te voeren
Onvoldoende rechten voor View / Create / Update / Delete

429 – Too Many Requests

De limiet voor het aantal verzoeken is overschreden
De frequentie van API-aanroepen overschrijdt de toegestane limiet

b. Succesrespons

200 – Success

Het verzoek is geldig
De API-actie is uitgevoerd
De gegevens worden in de juiste indeling teruggegeven

5. Limieten

Om de prestaties en stabiliteit van het systeem te waarborgen, geldt voor het API-gebruik een daglimiet voor verzoeken. Er is geen beperking per verzoek of korte tijdsinterval meer: je kunt de API zo vaak aanroepen als nodig, zolang je binnen het dagelijkse quotum van je abonnement blijft.

De daglimiet hangt af van het abonnement van de winkel:

Abonnement	Daglimiet verzoeken
Free	5 verzoeken/dag
Starter	50 verzoeken/dag
Growth	250 verzoeken/dag
Enterprise	500 verzoeken/dag

De dagteller wordt elke dag om middernacht (servertijd) gereset.

Als de daglimiet wordt overschreden, geeft het systeem het volgende terug:

429 – Too Many Requests

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

Was dit nuttig?