Zum Hauptinhalt springen

Die koppla API nutzen

Mit der REST API kannst du koppla-Daten programmatisch abrufen und in eigene Tools, Dashboards oder Reporting-Pipelines einbinden.

M
Verfasst von Markus Willner

Wofür ist die API?

koppla lebt von kollaborativer Terminplanung — und manchmal braucht man die Planungsdaten trotzdem außerhalb der App. Vielleicht willst du ein eigenes Dashboard bauen, Projektinformationen automatisch in ein BI-Tool überführen oder interne Auswertungen auf den aktuellen Stand deiner Projekte aufsetzen.

Genau dafür gibt es die koppla REST API. Sie liefert dir strukturierte Projekt- und Terminplandaten als JSON — direkt aus koppla, ohne manuellen Export.

Ein konkretes Beispiel: In unserem Artikel Power BI mit koppla nutzen zeigen wir, wie du koppla-Daten in Power BI einbindest und eigene Reports darauf aufbaust.

Wann reicht ein Export? Wenn du Daten einmalig als PDF, Excel oder Gantt-Datei brauchst, ist der Terminplan-Export meist der einfachere Weg. Die API lohnt sich, wenn du Daten regelmäßig und automatisiert abrufen möchtest.


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.


Voraussetzungen

Der API-Zugang ist ein Zusatzfeature — ähnlich wie unternehmensweite Terminplan-Vorlagen. Er muss für euer Unternehmen freigeschaltet sein, bevor Nutzer persönliche API Keys erstellen können. Bei Fragen dazu, meldet euch gerne über den Support-Button in koppla.


API Keys erstellen und verwalten

API Keys sind persönliche Zugangsdaten. Jeder Key gehört zu dir als Nutzer und ist fest an dein Unternehmen gebunden. Du siehst mit einem Key nur die Projekte und Daten, auf die du in koppla ohnehin Zugriff hast.

Persönlichen Key anlegen

  1. Öffne deine Einstellungen in koppla.

  2. Gehe zu Sicherheit & Zugang.

  3. 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 Unternehmens-Admin kannst du zusätzlich alle API Keys eures Mandanten 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 auch löschen, zum Beispiel wenn ein Key kompromittiert wurde oder ein Teammitglied das Unternehmen verlässt.


Die API nutzen

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>

Die API ist aktuell rein lesend — du kannst mit einem API Key nur Daten abrufen (GET-Anfragen). Planungsdaten in koppla ändern oder neue Einträge anlegen geht über die API Keys nicht; dafür nutzt du weiterhin die koppla-Oberfläche.

Erste Anfrage

So kannst du testen, ob dein Key funktioniert — zum Beispiel mit curl im Terminal:

curl -H "Authorization: Bearer DEIN_API_KEY" \\ 
<https://api-v2.koppla.de/projects>

Du bekommst eine Liste aller Projekte zurück, auf die dein Account Zugriff hat.

Welche Daten kann ich abrufen?

Die API wächst schrittweise. 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.


Verwandte Artikel


Fragen oder Feedback? Melde dich gerne über den Support-Button in koppla.

Hat dies deine Frage beantwortet?