Wie generiere ich einen ventic-API-Key?

Die Integration mit der ventic-Plattform erfordert einen API-Key zur Authentifizierung von Anfragen. Diese Schlüssel sind für Ihre Organisation eindeutig und bieten sicheren Zugriff auf Ihren Produktkatalog und Ihre Handelsdienste.

So verwalten Sie Ihre API-Keys.

1. Zugriff auf das Entwickler-Dashboard

Melden Sie sich bei Ihrem ventic-Konto an und navigieren Sie zum Bereich Einstellungen > Entwickler (Settings > Developers). Dort finden Sie den Reiter „API-Keys“.

2. Einen neuen Schlüssel generieren

Um einen neuen Schlüssel zu erstellen:

1. Klicken Sie auf die Schaltfläche „API-Key erstellen“ (Create API Key).
2. Geben Sie dem Schlüssel einen beschreibenden Namen (z. B. „Produktion - Hauptshop“ oder „Test - Max Mustermann“).
3. Wählen Sie den Berechtigungsumfang (Scopes). Wir empfehlen, Schlüsseln nur die notwendigen Berechtigungen zu erteilen (Prinzip der geringsten Privilegien).
4. Klicken Sie auf „Generieren“.

3. Sichere Speicherung des Schlüssels

Nach der Generierung wird Ihnen der Schlüssel nur ein einziges Mal angezeigt.

• Wichtig: Kopieren Sie den Schlüssel und speichern Sie ihn an einem sicheren Ort (z. B. in einem Passwort-Manager oder einem sicheren Key-Vault in Ihrer Infrastruktur).
• Hinweis: Aus Sicherheitsgründen zeigt ventic den vollständigen Schlüssel nach dem Schließen des Fensters nicht erneut an.

4. Verwendung des Schlüssels in Anfragen

Alle Anfragen an die ventic-API sollten den API-Key im HTTP-Header X-API-Key enthalten.

Beispiel für die Verwendung mit cURL:

curl -X GET "https://api.ventic.ai/v1/products" \
     -H "X-API-Key: dein_api_key_hier" \
     -H "Accept: application/json"

5. Schlüsselrotation und Löschen

Wenn Sie vermuten, dass ein Schlüssel offengelegt wurde, sollten Sie ihn sofort für ungültig erklären.

• Wählen Sie im Dashboard den Schlüssel aus, den Sie löschen möchten, und klicken Sie auf „Widerrufen“ (Revoke).
• Nach dem Widerruf werden alle Anfragen, die diesen Schlüssel verwenden, abgelehnt.
• Generieren Sie einen neuen Schlüssel und aktualisieren Sie Ihre Konfiguration.

Best Practices für die Sicherheit

• Veröffentlichen Sie API-Keys niemals im Quellcode (z. B. auf GitHub). Verwenden Sie Umgebungsvariablen.
• Verwenden Sie separate Schlüssel für Test- und Produktionsumgebungen.
• Überprüfen Sie regelmäßig die Liste der aktiven Schlüssel und entfernen Sie diejenigen, die nicht mehr benötigt werden.

Wenn Sie Hilfe bei der Integration benötigen, wenden Sie sich bitte an unser technisches Team unter support@ventic.ai.