Nutze Client Applications und API-Keys, um dich gegenüber der öffentlichen awork API zu authentifizieren – unabhängig davon, ob du eine eigene App, eine Integration oder die Anbindung von Business-Intelligence-Tools (BI/Analytics) umsetzen möchtest.
Wichtig: Da die awork API öffentlich ist, musst du dich entsprechend authentifizieren.
Hauptvorteile und Anwendungsfälle
Wähle die Authentifizierungsmethode, die zu deinem Anwendungsfall passt:
Useranmeldung mit Userechten für Apps, bei denen sich jede Person mit ihrem eigenen awork-Konto anmeldet und die jeweiligen Berechtigungen angewendet werden
API-Key ohne Userbezug (Administratorrechte) für Analytics, Schnittstellen und ähnliche Anwendungsfälle, bei denen keine Useranmeldung erforderlich ist
Entwickle individuelle Apps und Integrationen auf Basis der awork API – derselben Grundlage, auf der auch die Web-App basiert
So verwendest du Client Applications und API-Keys
awork unterstützt zwei gängige Ansätze – wähle den, der zu deinem Szenario passt.
Eine Client Application für die Useranmeldung (OAuth 2.0) erstellen
Nutze diese Option, wenn sich User*innen mit ihrem eigenen awork-Konto in deiner App oder Integration anmelden sollen.
Tipp: Die Useranmeldung ist die richtige Wahl, wenn die Userrechteverwaltung angewendet werden soll (über OAuth 2.0).
Navigiere zu den Einstellungen
Öffne den Bereich Integrationen und gehe zu API Clients
Klicke auf + API Client
Gib einen Namen und eine Client ID ein (diese ID muss eindeutig sein)
Füge eine Redirect URL hinzu (siehe Developer Resources für Details)
Klicke auf Speichern
Kopiere nach dem Speichern das Client Secret und bewahre es sicher auf
Verwende die Client ID und das Client Secret, um deine OAuth-2.0-Anmeldung zu implementieren, damit sich User*innen mit ihrem awork-Konto authentifizieren können.
Weitere Informationen zur OAuth-2.0-Anmeldung findest du in den Developer Resources.
Einen API-Key ohne Userauthentifizierung erstellen
Nutze diese Option, wenn du lediglich einen API-Key benötigst, um Daten abzufragen oder eine Integration zu betreiben, bei der keine Useranmeldung erforderlich ist.
Navigiere zu den Einstellungen
Öffne den Bereich Integrationen und gehe zu API clients
Klicke auf + API Client, um eine neue Client Application zu erstellen
Vergib einen Namen und eine Client ID (diese ID muss eindeutig sein)
Klicke auf Speichern
Wähle deine neue Anwendung in der Liste der Client Applications
Klicke auf das Symbol mit den drei Punkten und wähle API-Keys verwalten
Klicke auf +, um einen neuen API-Key hinzuzufügen
Klicke auf das kleine Schlüsselsymbol auf der rechten Seite, um den API-Key zu kopieren
Bewahre den API-Key sicher auf und verwende ihn für deine Integration oder Datenabfrage
Nutze die Developer Resources, um mehr über die Verwendung des API-Keys zu erfahren.
Hinweis: In diesem Szenario ist die Redirect URL nicht relevant, da ausschließlich der API-Key benötigt wird.
Details zum Erstellen eines API-Keys ohne Userbezug mit Administratorrechten findest du unter Authentication: API key.
Best Practices und Support
Bewahre Secrets und API-Keys nach dem Kopieren sicher auf
Verwende beim Erstellen einer Client Application eine eindeutige Client ID
Nutze die Developer Resources für Details zur Implementierung von OAuth 2.0 und API-Keys
FAQ
Was ist der Unterschied zwischen einer Client Application und einem API-Key?
Was ist der Unterschied zwischen einer Client Application und einem API-Key?
Eine Client Application wird in awork erstellt, um die Authentifizierung zu ermöglichen. Je nach Anwendungsfall kann sie für die Useranmeldung (OAuth 2.0) oder zur Generierung eines API-Keys für Datenabfragen und Integrationen verwendet werden.
Wann sollte ich die Useranmeldung (OAuth 2.0) verwenden?
Wann sollte ich die Useranmeldung (OAuth 2.0) verwenden?
Nutze sie, wenn sich User*innen mit ihrem eigenen awork-Konto anmelden sollen und die Userrechteverwaltung angewendet werden soll.
Benötige ich eine Redirect URL?
Benötige ich eine Redirect URL?
Für die Useranmeldung (OAuth 2.0) musst du eine Redirect URL hinzufügen (siehe Developer Resources für Details). Wenn du nur einen API-Key benötigst, ist die Redirect URL nicht relevant.
Was sind Client ID und Client Secret?
Was sind Client ID und Client Secret?
Beim Erstellen einer Client Application legst du eine eindeutige Client ID fest. Nach dem Speichern der Anwendung erhältst du das Client Secret, das du kopieren und sicher aufbewahren solltest.
Wo erstelle ich Client Applications in awork?
Wo erstelle ich Client Applications in awork?
Gehe zu Einstellungen → Integrationen und scrolle zu API clients.
Wo kann ich mehr über die API-Authentifizierung erfahren?
Wo kann ich mehr über die API-Authentifizierung erfahren?
Nutze die Developer Resources. Spezifische Informationen zu API-Keys findest du unter Authentication: API key.