API-Schlüssel

API-Zugänge für Integrationen erstellen und verwalten.

Unter Organization → API Keys werden Zugriffsschlüssel für technische Integrationen verwaltet.

Verwendung

API-Schlüssel werden genutzt, wenn externe Systeme Daten lesen oder schreiben sollen, zum Beispiel PIM, ERP, CRM, DAM, Middleware oder Automatisierungen.

Für digitale Produktpässe ist es sinnvoll, Integrationen je Ebene zu trennen:

EbeneTypisches führendes SystemGrund
ProduktPIMProduktbeschreibungen, GTIN, Bilder und technische Basisdaten werden dort gepflegt.
ChargeERPProduktion, Lager, Chargenfreigaben und Prüfzeugnisse entstehen dort.
SeriennummerERP, CRM oder Service-SystemIndividuelle Auslieferungs-, Garantie- oder Servicedaten entstehen je Einheit.

Getrennte Schlüssel pro System erleichtern Rechtevergabe, Rotation und Fehleranalyse.

Einrichtung

  1. Neuen API-Schlüssel erstellen.
  2. Namen und Zweck dokumentieren.
  3. Berechtigungen passend zum Integrationsfall vergeben.
  4. Schlüssel direkt nach der Erstellung sicher hinterlegen.
  5. Integration gegen die API-Dokumentation testen.

Betrieb

  • Verwende getrennte Schlüssel pro System oder Umgebung.
  • Entferne nicht mehr genutzte Schlüssel.
  • Rotiere Schlüssel regelmäßig.
  • Nutze nur die Rechte, die die Integration wirklich benötigt.
Ein API-Schlüssel sollte wie ein Passwort behandelt werden. Nachträglich ist der vollständige Secret-Wert in der Regel nicht erneut sichtbar.