Skip to main content
Jede Anfrage an die Pioneer API erfordert einen API-Schlüssel, der im X-API-Key-Header übergeben wird. Erstellen Sie Schlüssel im Pioneer-Dashboard und verwenden Sie anschließend die Endpunkte zur Schlüsselverwaltung, um bestehende Schlüssel programmatisch aufzulisten und zu widerrufen.
Speichern Sie API-Schlüssel in Umgebungsvariablen, statt sie fest im Quellcode zu hinterlegen. Legen Sie beispielsweise PIONEER_API_KEY in Ihrer Umgebung fest und lesen Sie den Wert zur Laufzeit ein. Committen Sie API-Schlüssel niemals in die Versionskontrolle.

​
Einen API-Schlüssel erstellen

POST /create-api-key Erstellt einen neuen API-Schlüssel, der Ihrem Konto zugeordnet ist. Dieser Endpunkt wird vom Pioneer-Dashboard verwendet und erfordert eine Browser-Sitzung. Mit einem bestehenden API-Schlüssel authentifizierte Aufrufe werden mit 403 Forbidden abgelehnt, um Credential Chaining zu verhindern. Request Body
​
string
erforderlich
Ein aussagekräftiger Name zur Identifizierung dieses Schlüssels. Verwenden Sie Namen, die den Zweck des Schlüssels oder den zugehörigen Dienst widerspiegeln, zum Beispiel "ci-pipeline" oder "production-inference".
Verwenden Sie keinen bestehenden API-Schlüssel, um einen weiteren API-Schlüssel zu erstellen. Die Authentifizierung per X-API-Key wird für diesen Endpunkt nicht akzeptiert. Erstellen Sie Schlüssel unter Settings -> API Keys im Dashboard.
Response
​
string
Der vollständige Wert des API-Schlüssels. Dies ist das einzige Mal, dass er im Klartext zurückgegeben wird. Kopieren Sie ihn sofort und speichern Sie ihn an einem sicheren Ort wie einem Secrets-Manager oder einer Umgebungsvariable.
​
string
Eindeutige Kennung des Schlüssels. Verwenden Sie diese ID, wenn Sie den Schlüssel widerrufen.
​
string
Der Name, den Sie dem Schlüssel zugewiesen haben.
​
string
ISO-8601-Zeitstempel des Erstellungszeitpunkts des Schlüssels.
​
string
Letzte Ziffern des erzeugten Schlüssels zur Anzeige und Identifikation.
​
string | null
Optionaler ISO-8601-Ablaufzeitpunkt oder null, wenn der Schlüssel nicht abläuft.
​
string
Team, an das der Schlüssel gebunden ist.
​
boolean
Gibt an, ob Pioneer während der Schlüsselerstellung einen Stripe-Kundendatensatz angelegt hat.
Der vollständige Schlüsselwert wird nur bei der Erstellung zurückgegeben. Wenn Sie ihn verlieren, müssen Sie den Schlüssel widerrufen und einen neuen erstellen.

​
API-Schlüssel auflisten

GET /list-api-keys Gibt alle Ihrem Konto zugeordneten API-Schlüssel zurück. Schlüsselwerte sind in der Antwort maskiert. Es werden nur Metadaten wie Name und Erstellungsdatum zurückgegeben.
Response
​
object[]
Array mit Metadatenobjekten der API-Schlüssel.
​
number
Anzahl der zurückgegebenen Schlüssel.

​
Einen API-Schlüssel widerrufen

DELETE /delete-api-key Widerruft einen API-Schlüssel dauerhaft. Anfragen, die den widerrufenen Schlüssel verwenden, erhalten sofort 401 Unauthorized-Antworten. Request Body
​
string
erforderlich
Die eindeutige ID des zu widerrufenden Schlüssels, wie sie von GET /list-api-keys zurückgegeben wird.
Das Widerrufen eines Schlüssels erfolgt sofort und ist unwiderruflich. Stellen Sie sicher, dass alle Dienste, die den Schlüssel verwenden, auf einen Ersatzschlüssel umgestellt sind, bevor Sie den alten widerrufen, um Dienstunterbrechungen zu vermeiden.
Response Gibt 200 OK mit einem JSON-Erfolgsbody zurück.
​
boolean
Gibt an, ob der Schlüssel widerrufen wurde.
​
string | null
Menschenlesbare Statusmeldung.