Erstelle deine eigene App mit der ClickUp API

Möchtest du eine App erstellen, die sich mit ClickUp integriert? Gib deinen Nutzern die Möglichkeit, sich mit OAuth 2.0 anzumelden!

Schau dir auch unsere API-Dokumentation an!

Was du benötigst

  • Die ClickUp API ist für alle ClickUp-Pläne verfügbar.
  • Workspace-Eigentümer oder Admins können Integrationseinstellungen verwalten und OAuth-Apps im Workspace erstellen.
  • Mitglieder und eingeschränkte Mitglieder mit vollständigen Bearbeitungsberechtigungen können persönliche API-Tokens verwenden.
  • Eingeschränkte Mitglieder mit reinen Anzeigeberechtigungen können nicht auf die API zugreifen oder sie verwalten.

OAuth 2-Ablauf

Wenn du eine Anwendung entwickeln möchtest, die andere nutzen können, musst du einen OAuth2-Authentifizierungsablauf verwenden.

Mit OAuth 2 erhält jede Person, die deine App nutzt, ein individuelles Token. Jeder Nutzer kann nur auf die Inhalte zugreifen, die für sein individuelles ClickUp-Benutzerkonto verfügbar sind.

Falls du mit OAuth2 noch nicht vertraut bist, hat Digital Ocean einen hilfreichen Leitfaden zusammengestellt, der dir den Einstieg erleichtert. Wir empfehlen außerdem, die OAuth-Website für weitere Details zu besuchen.

App erstellen

Der erste Schritt zur Nutzung von OAuth 2 ist das Erstellen einer App in deinem Workspace. Du musst Workspace-Eigentümer oder Admin sein, um Integrationseinstellungen zu verwalten.

So erstellst du eine App in deinem Workspace:

  1. Klicke in der oberen linken Ecke auf deinen Workspace-Avatar.
  2. Wähle Einstellungen.
  3. Wähle in der Seitenleiste „Alle Einstellungen" die Option ClickUp API.
  4. Klicke in der oberen rechten Ecke der Seite „ClickUp API-Einstellungen" auf „App erstellen".

    Screenshot der Schaltfläche „App erstellen

  5. Gib den Namen deiner App und eine oder mehrere Weiterleitungs-URLs ein. Wenn du nicht sicher bist, welche Weiterleitungs-URL du verwenden sollst, sieh dir den Leitfaden zu Weiterleitungs-URLs auf der OAuth-Website an.
  6. Klicke auf App erstellen.
  7. Auf dem nächsten Bildschirm siehst du, dass eine Client-ID und ein Client-Secret generiert wurden.
  8. Verwende die Client-ID und das Client-Secret in deiner App, um einen OAuth 2-Authentifizierungsablauf zu erstellen.

Screenshot des App-Modals mit OAuth2.

Weiterleitungs-URLs aktualisieren

Wenn du eine neue Weiterleitungs-URL hast, kannst du diese Einstellungen jederzeit in deinem ClickUp-Workspace anpassen:

  1. Klicke in der oberen linken Ecke auf deinen Workspace-Avatar.
  2. Wähle Einstellungen.
  3. Wähle in der Seitenleiste „Alle Einstellungen" die Option ClickUp API.
  4. Klicke auf eine vorhandene App, um deren Details einzublenden.
  5. Aktualisiere die Weiterleitungs-URL.
  6. Klicke auf Speichern.

Client-Secret anzeigen oder neu generieren

So generierst du dein Client-Secret neu:

  1. Klicke in der oberen linken Ecke auf deinen Workspace-Avatar.
  2. Wähle Einstellungen.
  3. Wähle in der Seitenleiste „Alle Einstellungen" die Option ClickUp API.
  4. Klicke auf eine vorhandene App, um deren Details einzublenden.
  5. Klicke auf Anzeigen, um dein aktuelles Client-Secret einzusehen.
  6. Klicke auf Neu generieren, um ein neues Client-Secret zu erstellen.
  7. Aktualisiere deine App, damit sie das neue Client-Secret verwendet.

Autorisierungs-Token-Typen

Tokens ermöglichen dir API-Aufrufe und die Integration mit anderen Anwendungen. Du kannst auch Apps wie Make nutzen, um Integrationen ohne Programmieraufwand zu erstellen. Tokens sind an dein ClickUp-Benutzerkonto gebunden.

Jede Person mit einem ClickUp-Konto kann ein persönliches Token generieren. Persönliche Tokens gewähren Zugriff auf jeden Workspace, den dein Konto erstellt hat oder dem es beigetreten ist. Dein persönliches Token gibt dir denselben Zugriff, den du auch über einen Webbrowser hast.

Wenn du OAuth2 verwendest, kannst du bei der ersten Authentifizierung – oder später bei einer erneuten Authentifizierung – festlegen, für welche Workspaces der Zugriff autorisiert werden soll.

Screenshot einer Person, die auswählt, welche Workspaces mit OAuth2 autorisiert werden sollen.