Entwickler-API-Zugriff einrichten

Wenn Sie eine externe Anwendung entwickeln oder mit Ihrem Online-Shop verbinden möchten – eine mobile App, eine Integration oder eine eigene Storefront – benötigt diese Zugangsdaten für die Shop-API. In Vinosoft erstellen Sie Zugriffstoken und registrieren OAuth-Clients unter Shop → Konfiguration → API.

Zugriffstoken

Zugriffstoken sind der einfachste Weg, ein Skript, einen Backend-Dienst oder eine Integration gegenüber der Shop-API zu authentifizieren.

Gehen Sie zu Shop → Konfiguration → API und klicken Sie unter Zugriffstoken auf Token erstellen.

1. Erfassen Sie eine Bezeichnung, die beschreibt, wofür das Token verwendet wird (z. B. "Mobile-App-Integration").
2. Wählen Sie den Token-Typ:
3. • Admin – voller Zugriff auf die Shop-API, eingeschränkt auf die von Ihnen ausgewählten Shop-Modulberechtigungen.
   • Storefront – nur öffentlicher Lesezugriff, für Fähigkeiten wie das Lesen von Artikeln, Kollektionen oder Inhalten sowie das Schreiben von Checkouts.
3. Wählen Sie die konkreten Berechtigungen (Scopes), auf die das Token beschränkt sein soll.
4. Klicken Sie auf Erstellen.

Der vollständige Token-Wert wird einmalig direkt nach der Erstellung angezeigt. Kopieren Sie ihn sofort in die Konfiguration Ihrer Anwendung – Vinosoft speichert danach nur noch das Präfix des Tokens und kann Ihnen den vollständigen Wert nicht mehr erneut anzeigen.

Jedes Token in der Liste zeigt Präfix, Bezeichnung, Berechtigungen, Erstellungsdatum und letztes Nutzungsdatum, damit Sie Token auseinanderhalten und nicht mehr genutzte Token erkennen können. Um ein Token zu widerrufen, nutzen Sie die Aktion Widerrufen in der jeweiligen Zeile – dies stoppt sofort jede Anwendung, die das Token zur Authentifizierung verwendet.

Kundenkonto-OAuth-Clients

Wenn Sie eine kundenseitige App entwickeln, mit der sich Kundinnen und Kunden mit ihrem Vinosoft-Shop-Konto anmelden können, registrieren Sie statt eines Zugriffstokens einen OAuth-Client. Dabei handelt es sich um öffentliche PKCE-Clients – es wird kein Client-Secret ausgestellt oder gespeichert.

Klicken Sie unter Kundenkonto-OAuth-Clients auf Client registrieren:

1. Erfassen Sie einen Anzeigenamen für die Anwendung.
2. Erfassen Sie eine oder mehrere Redirect-URIs (eine pro Zeile), an die der OAuth-Ablauf Kundinnen und Kunden zurückleiten darf.
3. Wählen Sie die Berechtigungen (Scopes), die der Client anfordern darf, etwa das Lesen der eigenen Kundendaten, das Lesen von Bestellungen oder das Schreiben von Adressen.
4. Aktivieren Sie optional Password-Grant erlauben, falls Ihre Anwendung dies benötigt.
5. Klicken Sie auf Registrieren.

Nach der Registrierung zeigt Vinosoft die generierte Client-ID an – kopieren Sie diese in Ihre Anwendung. Da kein Secret ausgestellt wird, achten Sie darauf, die Client-ID zusammen mit Ihren registrierten Redirect-URIs und dem PKCE-Ablauf abzusichern.

Jeder registrierte Client zeigt Name, Berechtigungen, Redirect-URIs, Password-Grant-Einstellung und Status. Nutzen Sie die Aktion Deaktivieren in der Zeile eines Clients, um zu verhindern, dass er Kundinnen und Kunden weiterhin authentifiziert – zum Beispiel, wenn eine App ausser Betrieb genommen wird oder Sie vermuten, dass ihre Konfiguration kompromittiert wurde.

Verwandt: Konfiguration, Shop-Integrationen einrichten.