Mit einem API-Schlüssel kann ein anderes System, zum Beispiel deine eigene Software oder ein Partner-Tool, mit deinen Sweeply-Aufgaben arbeiten. In diesem Artikel erfährst du, wie du einen Schlüssel erstellst, kopierst und löschst.
Bevor du startest
Du brauchst die Admin-Rolle in Sweeply.
Der Tab API Keys wird nur bei Konten angezeigt, für die der API-Zugriff aktiviert ist. Wenn du ihn nicht siehst, schreib uns im Chat.
Du verbindest Mara oder Duve? Dann erstelle hier keinen Schlüssel. Nutze stattdessen Settings → Integrations. Dort wird ein Schlüssel erstellt, der nur den Zugriff hat, den die Integration braucht.
Schlüssel erstellen
Öffne Settings, dann Account, und wähle den Tab API Keys.
Wähle Create API Key.
Gib dem Schlüssel einen Namen, der zeigt, wo er verwendet wird, zum Beispiel den Namen des Systems, das du verbindest. Jeder Schlüssel braucht einen eigenen Namen.
Wähle Save.
Sweeply zeigt API Key Created an. Wähle Copy Key und füge den Schlüssel in das andere System ein oder speichere ihn an einem sicheren Ort, zum Beispiel in einem Passwort-Manager.
Wähle Close.
Der Schlüssel wird nur einmal angezeigt. Nachdem du das Fenster geschlossen hast, kannst du ihn nicht mehr sehen. Wenn du ihn verlierst, lösche den Schlüssel und erstelle einen neuen.
Was der Schlüssel kann
Ein hier erstellter Schlüssel kann Aufgaben in deiner Unterkunft erstellen, lesen, aktualisieren und löschen. Die Spalte Permissions in der Liste zeigt, was jeder Schlüssel kann.
Behandle den Schlüssel wie ein Passwort. Wer ihn hat, kann deine Aufgaben ändern. Teile ihn nie per E-Mail oder Chat.
Schlüssel löschen
Suche den Schlüssel in Settings → Account → API Keys in der Liste.
Wähle das Löschen-Symbol in der Spalte Actions und bestätige.
Der Schlüssel funktioniert sofort nicht mehr, und kein System, das ihn nutzt, kann Sweeply noch erreichen. Das lässt sich nicht rückgängig machen.
Fragen
Kann ich einen Schlüssel nach dem Erstellen noch einmal sehen? Nein. Sweeply zeigt ihn nur einmal an. Erstelle einen neuen Schlüssel und lösche den alten.
Ich glaube, jemand anderes hat unseren Schlüssel. Was tun? Lösche den Schlüssel sofort, erstelle dann einen neuen und füge ihn in die Systeme ein, die ihn haben sollen.
Läuft ein Schlüssel ab? Nein. Er funktioniert, bis du ihn löschst.