ℹ️ Wichtig: Die abrufbaren Daten hängen von deinen Berechtigungen in koppla ab. Du siehst über die API nur die Projekte und Daten, auf die du auch in koppla Zugriff hast.
Wofür nutze ich die API?
Du willst mit Daten aus deinem Terminplan arbeiten, aber außerhalb von koppla? Zum Beispiel ein eigenes Dashboard bauen, Projektinformationen automatisch in ein BI-Tool überführen oder interne Auswertungen immer auf dem aktuellen Stand deiner Projekte halten? Dann ist die koppla REST API genau das Richtige für dich!
Statt deine Daten manuell zu exportieren, rufst du sie über die API strukturiert als JSON ab: direkt aus koppla und automatisiert, so oft du möchtest.
Ein konkretes Beispiel: In unserem Artikel Power BI mit koppla nutzen zeigen wir dir, wie du koppla-Daten in Power BI einbindest und eigene Reports darauf aufbaust.
ℹ️ Wann reicht ein Export? Wenn du Daten nur einmalig als PDF, Excel oder Gantt-Datei brauchst, ist der Terminplan-Export meist der einfachere Weg. Die API lohnt sich vor allem dann, wenn du Daten regelmäßig und automatisiert abrufen möchtest.
Was ist eine API?
Eine API (Application Programming Interface) ist eine Schnittstelle, über die Software miteinander spricht. Statt selbst in koppla zu klicken, schickt dein Programm eine Anfrage an unsere Server und bekommt die gewünschten Daten strukturiert und maschinenlesbar zurück.
Du musst kein Entwickler sein, um API Keys zu verwalten. Zum Abrufen und Verarbeiten der Daten brauchst du aber in der Regel jemanden im Team, der mit HTTP-Anfragen und JSON vertraut ist.
Zwei Dinge sind dabei gut zu wissen:
Die API ist rein lesend. Du kannst Daten nur abrufen (GET-Anfragen). Planungsdaten in koppla ändern oder neue Einträge anlegen geht über die API nicht. Dafür nutzt du weiterhin die koppla-Oberfläche.
Du siehst nur deine Daten. Über die API erhältst du genau die Projekte und Informationen, auf die du auch in koppla Zugriff hast.
Was brauche ich, um loszulegen?
Der API-Zugang ist eine Zusatzfunktion, ähnlich wie unternehmensweite Vorlagen Er muss zunächst für euer Unternehmen freigeschaltet sein, bevor du und deine Kolleg:innen persönliche API Keys erstellen können.
Sobald der Zugang aktiv ist, brauchst du nur noch zwei Dinge:
einen persönlichen API Key (wie du ihn erstellst, zeigen wir dir im nächsten Abschnitt)
jemanden, der mit HTTP-Anfragen und JSON umgehen kann, um die Daten abzurufen und weiterzuverarbeiten
ℹ️ Noch nicht freigeschaltet? Wenn du nicht sicher bist, ob der API-Zugang für euer Unternehmen aktiv ist, oder ihn freischalten lassen möchtest, melde dich gerne über den Support-Button in koppla.
Wie erstelle und verwalte ich meine API Keys?
API Keys sind deine persönlichen Zugangsdaten. Jeder Key gehört zu dir als Nutzer und ist fest an dein Unternehmen gebunden.
Persönlichen Key anlegen
Öffne deine Einstellungen in koppla
Gehe zu Sicherheit & Zugang
Erstelle einen neuen API Key und vergib einen Namen, z. B. „Power BI Dashboard“ oder „Internes Reporting“, damit du später weißt, wofür der Key genutzt wird
Key sicher aufbewahren
⚠️ Wichtig: Den vollständigen Key-Wert siehst du in koppla nur unmittelbar nach dem Erstellen. Kopiere ihn direkt und bewahre ihn sicher auf, zum Beispiel in einem Passwort-Manager oder einem Secrets Vault. Danach ist in koppla nur noch erkennbar, dass ein Key existiert, nicht der Key selbst.
Teile deinen API Key nicht per E-Mail oder Chat und speichere ihn nicht unverschlüsselt in geteilten Dokumenten.
Keys als Admin verwalten
Als Administrator kannst du zusätzlich alle API Keys eures Unternehmens/Arbeitsbereiches einsehen: also welche Nutzer welche Keys angelegt haben. Den Key-Wert selbst siehst du dabei nicht, nur Name, Ersteller und ob der Key aktiv ist.
Admins können Keys außerdem löschen, zum Beispiel wenn ein Key kompromittiert wurde oder ein Teammitglied das Unternehmen verlässt.
Was ist eine API?
Eine API (Application Programming Interface) ist im Grunde eine Schnittstelle, über die Software miteinander sprechen kann. Statt selbst in koppla zu klicken, schickt dein Programm eine Anfrage an unsere Server und bekommt die gewünschten Daten zurück — strukturiert und maschinenlesbar.
Du musst kein Entwickler sein, um API Keys zu verwalten. Zum Abrufen und Verarbeiten der Daten brauchst du aber in der Regel jemanden im Team, der mit HTTP-Anfragen und JSON vertraut ist.
Wie richte ich die API ein?
Sobald du einen API Key hast, kannst du loslegen. Du brauchst dafür nur die Basis-URL und deinen Key.
Basis-URL
Alle Anfragen gehen an:
<https://api-v2.koppla.de>
Authentifizierung
Sende deinen API Key bei jeder Anfrage im Header mit:
Authorization: Bearer <dein-api-key>
Erste Anfrage testen
Um zu prüfen, ob dein Key funktioniert kannst du zum Beispiel einen curl im Terminal nutzen:
curl -H "Authorization: Bearer DEIN_API_KEY" \\
<https://api-v2.koppla.de/projects>
Als Antwort bekommst du eine Liste aller Projekte zurück, auf die dein Account Zugriff hat. Klappt das, funktioniert dein API Key!
Welche Daten kann ich abrufen?
Die API wächst schrittweise und wir bauen sie kontinuierlich aus. Aktuell kannst du unter anderem folgende Daten abrufen, immer im Rahmen deiner bestehenden koppla-Berechtigungen:
Projektdaten: Projektlisten, Details und Metadaten zu deinen Projekten
Terminplandaten: Vorgänge, Meilensteine, Abhängigkeiten, Struktur, Gewerke und Projektbeteiligte
Standmeldungen: Fortschrittsmeldungen zu Vorgängen, inklusive der jeweils neuesten Meldung pro Vorgang
Basisplan: den aktuellen Basisplan eines Projekts, inklusive der zugehörigen Vorgänge
Unternehmens- & Nutzerdaten: Informationen zu deinem Unternehmen und deinem Nutzerprofil
Welche Endpunkte es genau gibt, findest du in unserer stets aktualisierten interaktiven API-Dokumentation:
Dort kannst du jeden Endpunkt durchklicken, Parameter und Antwortformate einsehen und Anfragen direkt ausprobieren.
ℹ️ Tipp: Da die API laufend erweitert wird, lohnt sich ab und zu ein Blick in die Doku. So siehst du, welche neuen Daten und Endpunkte dazugekommen sind.