Die awork Web App ist eine Single Page Application (SPA), die über die awork API mit dem awork Server kommuniziert. Diese API ist öffentlich und somit zugänglich für die Erstellung eigener Apps, Integrationen oder für die Anbindung von Business Intelligence Tools (BI / Analytics).
Öffentlich bedeutet hier natürlich trotzdem, dass eine entsprechende Authentifizierung vorgenommen werden muss.
API-Key mit User-Rechten
Sollen sich die User selbst an der eigens entwickelten App/Integration mit ihrem awork-Account anmelden können, so muss in awork dafür eine neue Client Application angelegt werden.
☝️Hinweis: Die User-Anmeldung ist wichtig für Apps und Anwendungen, wo das Rechte-Management des*r Users*in greifen soll (dies erfolgt über oAuth 2.0 – mehr dazu in den Developer Resources).
API-Key ohne User-Bezug mit Admin-Rechten
Spielt das keine Rolle, so kann auch ein API-Key ohne User-Bezug mit Admin-Rechten generiert werden, z.B. für Analytics, Schnittstellen, etc. Hier erfährst du, wie du an den Key kommst.
Clients für eigene Apps mit User-Anmeldung
Wenn du für awork deine eigene App bauen möchtest, wo sich die User selbst anmelden sollen, musst du dir dafür in awork eine Client Application anlegen. Gehe im Hauptmenü über Einstellungen in den Bereich Integration. Dort findest du den Bereich API Zugriff.
Klicke auf + API Client, um eine neue Client Application anzulegen.
Lege einen Namen und eine Client-Id fest (diese Id muss einzigartig sein).
Füge eine Redirect URL hinzu (siehe Developer Resources für mehr Details).
Speichere die Client Application.
Nach dem Speichern erhältst du das Client-Secret. Kopiere dieses und bewahre es sicher auf.
Mit der Client-Id und dem Client-Secret kannst du jetzt eine eigene oAuth 2.0 Anmeldung bauen, bei der sich die User selbst mit ihrem awork-Account authentifizieren können.
Schaue in unseren Developer Resources vorbei, um mehr über die oAuth 2.0-Anmeldung zu erfahren.
API Key ohne User-Authentifizierung
Wenn du für awork eine Integration bauen möchtest oder einfach einen API-Key zum Daten-Abfragen benötigst, musst du dir eine Client Application anlegen und einen API-Key generieren.
Gehe im Hauptmenü über Einstellungen in den Bereich Integration. Dort findest du den Bereich API Zugriff.
Klicke auf + um eine neue Client Application anzulegen.
Lege einen Namen und eine Client-Id fest (diese Id muss einzigartig sein).
Die Redirect URL ist in diesem Fall nicht relevant, da nur der API-Key benötigt wird.
Speichere die Client Application.
Schließe das Fenster mit dem Client-Secret.
In der Liste der Client Applications taucht jetzt deine neue Application auf.
Klicke auf den Button mit den drei Punkten und wähle API-Key verwalten aus.
Füge über den + Button einen neuen API-Key hinzu.
Über das kleine Schlüssel-Icon an der rechten Seite, kannst du nun den API-Key kopieren.
Kopiere den API-Key in die Zwischenablage und bewahre ihn sicher auf. Du kannst ihn nun für deine Integration oder Datenabfrage verwenden.
Schaue in unseren Developer Resources vorbei, um zu erfahren wie du mit dem API-Key weiterarbeiten kannst.
☝️ Hinweis: Für Fragen rund um unsere API kannst du in unserem Developer Forum ein neues Thema erstellen und dort deine Fragen direkt an unsere Entwicklung stellen.