Benutzerhandbuch

Die STACKIT API ist eine programmatische Schnittstelle für die Verwaltung von STACKIT Cloud-Produkten und -Diensten. Sie können sie verwenden, um Cloud-Ressourcen wie Server, Datenbanken und Speicher direkt per Code zu verwalten. Diese Funktion ermöglicht es Ihnen, Ressourcen ohne manuellen Eingriff zu erstellen, zu ändern und zu löschen, was ein zentraler Bestandteil der modernen Cloud-Entwicklung ist. Die API hilft Ihnen dabei, Ihre Cloud-Umgebung per Code zu steuern und wiederkehrende Aufgaben zu automatisieren, wie die Erstellung neuer Entwicklungsumgebungen oder die Bereitstellung von Sicherungen. Diese Automatisierung verringert menschliche Fehler und hilft Ihnen, reproduzierbare, skalierbare und komplexe Infrastruktur-Bereitstellungen umzusetzen.

STACKIT API Explorer

Für eine detaillierte, interaktive Übersicht über alle verfügbaren API-Endpunkte und zum Ausprobieren von Requests können Sie den offiziellen API Explorer konsultieren.

Erste Schritte

Bevor Sie mit der STACKIT API interagieren können, müssen Sie über ein aktives STACKIT-Konto und -Projekt verfügen. Sie können diese im STACKIT Portal, der zentralen Self-Service-Benutzeroberfläche der Plattform, erstellen. Alle programmatischen Interaktionen mit der STACKIT API erfordern außerdem einen Service Account. Dieser dient als nichtmenschliche Benutzeridentität für Automatisierungen und Integrationen. Sie können einen Service Account und den dazugehörigen Service Account Key erstellen, indem Sie der Anleitung Zugriff auf einen Service mittels Service Account folgen.

Authentifizierung (Verbindung zur API)

Die STACKIT API bietet zwei primäre Authentifizierungsmethoden für den programmatischen Zugriff: den Key flow und den Token flow. Der Key flow ist die empfohlene Methode für alle neuen Integrationen, um die Sicherheit zu erhöhen.

Token-Flow

Der Token-Flow ist eine einfachere Authentifizierungsmethode, die auf einem langlebigen Service-Account-Token basiert. Diese Methode ist weniger sicher als der Key-Flow, und wir empfehlen sie nicht für neue Projekte.

Da der Token-Flow bald entfernt wird, sollten Sie alle bestehenden Integrationen vor diesem Datum auf den Key-Flow migrieren. Erfahren Sie in unserem Migrationshandbuch, wie Sie vom Token-Flow zum Key-Flow migrieren.

Key-Flow

Der Key-Flow ist die bevorzugte Methode zur Authentifizierung, da er eine sicherere Möglichkeit zur Verwaltung des programmatischen Zugriffs bietet. Dieser Flow erfordert einen Service-Account-Schlüssel und einen privaten RSA-Schlüssel. Sie verwenden den privaten Schlüssel, um Anfragen zu signieren, was die Authentizität des Aufrufers gewährleistet, ohne ein langlebiges Geheimnis zu übertragen.

Erfahren Sie, wie Sie per Service-Account auf Services zugreifen können.