API-Schlüssel erstellen und verwalten
Einen Schlüssel für die öffentliche API erstellen, Berechtigungen und Ablauf wählen, ihn auf IP-Adressen beschränken und dann widerrufen.
Mit einem API-Schlüssel können Ihre Tools die öffentliche API von Upsellr im Namen Ihrer Organisation aufrufen. Der Zugang zur API ist dem Tarif Enterprise vorbehalten.
Wo Sie die Schlüssel finden
Öffnen Sie das Kontomenü, dann Verwalten und API & Webhooks. In einem anderen Tarif als Enterprise zeigt der Bereich „Im Enterprise-Tarif enthalten“ und eine Schaltfläche zum Tarifwechsel.
Einen Schlüssel erstellen
- Klicken Sie auf API-Schlüssel erstellen.
- Geben Sie ihm einen Name, der sagt, wofür er dient, zum Beispiel den Namen des Tools, das ihn verwendet.
- Wählen Sie eine Berechtigungsvorlage:
- Nur lesen: Kanäle, Produkte, Quellen, Workflows, Mitglieder und die Organisation lesen.
- Lesen & Schreiben: alles außer Workflows starten.
- Vollzugriff: alle Berechtigungen, einschließlich Workflows starten.
- Benutzerdefiniert: Aktivieren Sie die gewünschten Berechtigungen einzeln.
- Wählen Sie den Ablauf: 7 Tage, 30 Tage, 90 Tage, 1 Jahr, 3 Jahre, Kein Ablauf oder eine benutzerdefinierte Dauer von 1 bis 1.095 Tagen.
- Füllen Sie bei Bedarf Erlaubte IPs und Erlaubte User-Agents aus, durch Kommas getrennt.
- Klicken Sie auf Schlüssel erstellen.
Der Schlüssel wird nur einmal angezeigt. Kopieren Sie ihn und bewahren Sie ihn sicher auf, bevor Sie das Fenster schließen.
Die verfügbaren Berechtigungen
| Ressource | Berechtigungen |
|---|---|
| Kanäle | Erstellen, lesen, ändern, löschen |
| Produkte | Erstellen, lesen, ändern, löschen |
| Quellen | Lesen, Quelldateien ablegen |
| Workflows | Lesen, starten |
| Organisation | Organisation lesen, Mitglieder lesen |
Einen Schlüssel widerrufen
Klicken Sie in der Liste neben dem Schlüssel auf Widerrufen. Jede Integration, die ihn verwendet, funktioniert sofort nicht mehr. Diese Aktion ist unumkehrbar.
Gut zu wissen
- Nur Eigentümer und Administratoren erstellen und widerrufen Schlüssel. Mitglieder sehen sie schreibgeschützt.
- Die Liste zeigt für jeden Schlüssel seine Berechtigungen, sein Ablaufdatum und Zuletzt verwendet: Ein nie verwendeter Schlüssel ist oft ein Schlüssel, den Sie widerrufen sollten.
- Einen Workflow zu starten, kann viele Produkte und Credits betreffen. Geben Sie die Startberechtigung nur Integrationen, die sie brauchen.
- Erstellen Sie einen Schlüssel pro Integration, nur mit den nötigen Berechtigungen.
- Ein verlorener Schlüssel kann nicht erneut angezeigt werden: Widerrufen Sie ihn und erstellen Sie einen neuen.