API-Schlüssel anlegen

Ein API-Schlüssel ist das Zugangsdatum deiner Software. Er handelt als dein Händlerkonto und sieht nur deine eigenen Daten.

Schlüssel erstellen

1. Melde dich im Portal an: portal.shirtee.cloud.
2. Öffne KI-Assistent & API und wechsle auf den Bereich API-Schlüssel.
3. Lege einen Schlüssel an und vergib diese Angaben:

Angabe	Regel
Name	1 bis 64 Zeichen. Wähle einen Namen, an dem du die Software erkennst, zum Beispiel „Shop-Anbindung“.
Berechtigungen	Mindestens eine. Angeboten werden nur Berechtigungen, die für dein Konto freigeschaltet sind, siehe Scopes und Freischaltung.
Gültigkeit	1 bis 365 Tage, voreingestellt 90 Tage.

Das Token siehst du nur einmal

Nach dem Anlegen zeigt das Portal das Token genau einmal an. Kopiere es sofort in deinen Passwortmanager oder dein Secret-Management. Später ist es nicht mehr abrufbar. Hast du es verloren, widerrufe den Schlüssel und lege einen neuen an.

Zur Kontrolle schickt Shirtee an die Adresse des angemeldeten Benutzers eine E-Mail mit Name, Kennung, Berechtigungen und Ablaufdatum. Das Token steht nie in der Mail. Erkennst du den Schlüssel nicht wieder, widerrufe ihn.

Kennung und Status

In der Liste siehst du je Schlüssel eine Kennung (die ersten Zeichen), Berechtigungen, Erstellungs- und Ablaufdatum sowie den Status Aktiv, Widerrufen oder Abgelaufen. Die Kennung nennst du dem Support, wenn du Hilfe zu einem Schlüssel brauchst. Das Token selbst nennst du nie.

Berechtigungen ändern

Ein Schlüssel trägt genau die Berechtigungen, die du beim Anlegen gewählt hast. Brauchst du später mehr, lege einen neuen Schlüssel an und stelle deine Software um. Du kannst den alten danach widerrufen.

Schlüssel widerrufen

Widerrufe einen Schlüssel im selben Bereich. Der Widerruf wirkt ab der nächsten Anfrage: Sie liefert dann 403 mit der Meldung Scoped API key revoked. Ein abgelaufener Schlüssel liefert 401.

Wer Schlüssel anlegen kann

Nur angemeldete Händler. Der Schlüssel gilt für dein Konto. Gehört der Benutzer, der ihn angelegt hat, nicht mehr zu diesem Händler, antwortet der Schlüssel ebenfalls mit 403.

Sicher aufbewahren

• Speichere das Token nie im Quellcode, in Tickets oder in Chatnachrichten.
• Nutze für jede Software einen eigenen Schlüssel, damit du einzelne Zugänge widerrufen kannst.
• Gib einem Schlüssel nur die Berechtigungen, die die Software braucht.
• Trage Produktivschlüssel in der API-Referenz nur auf deinem eigenen Rechner ein.