API-Schnellstart

Die STACKIT Domain Services API ist eine RESTful-Schnittstelle, mit der Sie die Verwaltung Ihrer Domains, DNS-Zonen und zugehörigen Ressourcen automatisieren können.

Diese Anleitung zeigt Ihnen, wie Sie Zugriff auf die Testumgebung erhalten, Ihren Authentifizierungs-Token generieren und Ihre Organisations-ID abrufen.

Zugang zur Testumgebung anfordern

Wir empfehlen, Ihre Entwicklung in der Operational Testing Environment (OTE) zu beginnen. Die OTE ist ein Duplikat des Produktionssystems, auf dem keine realen, kostenpflichtigen Domain-Bestellungen ausgeführt werden.

1. Senden Sie eine E-Mail an domainservices@digits.schwarz, um Zugang anzufordern.
2. Geben Sie die Betreffzeile “API Zugang für OTE System anfordern” an.
3. Geben Sie die E-Mail-Adressen aller Teammitglieder an, die Zugang benötigen.

Zugriffs-Token generieren

Die API verwendet JSON Web Tokens (JWT) zur Autorisierung. Sie müssen Ihre Zugangsdaten gegen einen Zugriffs-Token eintauschen, bevor Sie geschützte Endpunkte aufrufen können.

1. Senden Sie eine POST-Anfrage an den Token-Endpunkt. Verwenden Sie für die OTE-Umgebung https://api.ote.stackit.domains/api/access-control/token.
2. Geben Sie Ihre Portal-E-Mail-Adresse und Ihr Passwort im Anfrage-Body an.

   {
     "email": "YOUR_PORTAL_EMAIL_ADDRESS",
     "password": "YOUR_PASSWORD"
   }

3. Extrahieren Sie das access_token aus der Antwort.

Token sind für 3600 Sekunden gültig (15 Minuten). Sobald ein Token ausläuft, gibt das System einen 401 Unauthorized-Fehler zurück und Sie müssen ein neues generieren.

Ihre Organisations-ID abrufen

Fast alle API-Endpunkte erfordern eine organizationId als Pfadparameter. Sie müssen diese ID mithilfe Ihres Zugriffs-Tokens abrufen.

1. Senden Sie eine GET-Abfrage an den Organisations-Endpunkt: https://publicapi.ote.stackit.domains/api/v1/organizations.
2. Fügen Sie Ihr Token im Authorization: Bearer <JWT_TOKEN>-Format zum HTTP-Header hinzu.
3. Kopieren Sie die organizationId aus der JSON-Antwort hinzu.

Sie können diese ID nun verwenden, um Aufgaben wie die Überprüfung der Domain-Verfügbarkeit, das Erstellen von DNS-Zonen oder die Verwaltung von Resource Records zu automatisieren.