Öffentliche APIs

Ein Überblick über die Public API: was sie kann, wie die Authentifizierung funktioniert und welche Ratenlimits gelten.

1. Umfang der API-Nutzung

a. Über die API unterstützte Funktionen

Die Public API ermöglicht den Zugriff auf die wichtigsten Funktionen der Wholesale-App, darunter:

Kernfunktionen: Wholesale Pricing, Volume Pricing, Registrierungsformular, Quick Order Form, Quick Buy Collection, Quick Buy Variant
Zusatzfunktionen: Order Limit, Shipping Rate, Extra Fee, Payment Term (in Kürze verfügbar)

b. Unterstützte Methoden

Die API unterstützt vollständige CRUD-Operationen mit den folgenden HTTP-Methoden:

GET – Daten abrufen
POST – Neue Daten erstellen
PUT – Vorhandene Daten aktualisieren
DELETE – Daten entfernen

API-Schlüsseln können die folgenden Berechtigungsstufen zugewiesen werden: Nur Lesen/Nur Schreiben, Lesen & Schreiben

Unterstützte Aktionen: Liste abrufen – Eintrag abrufen – Eintrag erstellen – Eintrag aktualisieren – Eintrag löschen

c. Unterstützte Shopify-Tarife:

Die Public API der Wholesale-App steht für Shopify-Shops zur Verfügung, die die folgenden Voraussetzungen erfüllen:

Es muss ein Produktivshop sein (nicht für Entwicklungs- oder Testshops verfügbar)
Der Gold-Tarif muss abonniert sein

2. Authentifizierung

Alle API-Anfragen müssen ordnungsgemäß authentifiziert sein, bevor sie verarbeitet werden.

a. Erforderliche Parameter

Jede API-Anfrage muss die folgenden Pflichtparameter enthalten:

Parameter	Beschreibung
`shop`	Shopify-Shop-Domain (z. B. mystore.myshopify.com)
`api_key`	In der Wholesale-App erstellter API-Schlüssel

Fehlt einer dieser Parameter, wird die Anfrage abgelehnt.

b. Verwaltung der API-Schlüssel

API-Schlüssel werden direkt in der Admin-Oberfläche der Wholesale-App erstellt und verwaltet.
Für jeden API-Schlüssel lassen sich bestimmte Berechtigungen festlegen: Nur Lesen/Nur Schreiben, Lesen & Schreiben

3. API-Struktur & Antwortformat

a. API-Endpunkt

Alle API-Anfragen sollten die folgende Basis-URL verwenden:

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

b. Funktionsspezifische Endpunkte

Jede Funktionsgruppe hat einen eigenen Endpunkt. Zum Beispiel:

Wholesale-Funktion:

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

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

(Die tatsächlichen Endpunkte können je nach Funktionalität abweichen.)

c. Unterstützte Abfrageparameter

Die API unterstützt mehrere allgemeine Abfrageparameter:

Parameter	Beschreibung
`status`	Status der Datensätze
`page`	Seitennummer für die Paginierung
`limit`	Anzahl der Datensätze pro Seite
`sort`	Sortierkriterien
`query`	Such- oder Filterbedingung

Beispielanfrage:

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

4. Antwortcodes

Jede API-Anfrage liefert einen der folgenden Statuscodes zurück:

a. Häufige Fehlerantworten

401 – Unauthorized

Mögliche Gründe:

Shop-URL fehlt
API-Schlüssel fehlt
Ungültige Shop-URL
Ungültiger API-Schlüssel
API-Schlüssel passt nicht zum Shop

403 – This action is unauthorized

Der API-Schlüssel hat keine Berechtigung für die angeforderte Aktion
Unzureichende Berechtigungen für Ansehen / Erstellen / Aktualisieren / Löschen

429 – Too Many Requests

Das Anfragelimit wurde überschritten
Die Häufigkeit der API-Aufrufe überschreitet das zulässige Ratenlimit

b. Erfolgsantwort

200 – Success

Die Anfrage ist gültig
Die API-Aktion wurde erfolgreich ausgeführt
Die Daten werden im korrekten Format zurückgegeben

5. Ratenlimit

Um Leistung und Stabilität des Systems zu gewährleisten, unterliegt die API-Nutzung einem täglichen Anfragelimit. Eine Drosselung pro Anfrage oder in kurzen Intervallen gibt es nicht mehr – Sie können die API beliebig oft aufrufen, solange Sie das Tageskontingent Ihres Tarifs einhalten.

Das tägliche Limit hängt vom Tarif des Shops ab:

Tarif	Tägliches Anfragelimit
Free	5 Anfragen/Tag
Starter	50 Anfragen/Tag
Growth	250 Anfragen/Tag
Enterprise	500 Anfragen/Tag

Der Tageszähler wird jeden Tag um Mitternacht (Serverzeit) zurückgesetzt.

Wird das Tageslimit überschritten, gibt das System Folgendes zurück:

429 – Too Many Requests

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

War diese Seite hilfreich?