Skip to main content
Jede Anfrage an die Pioneer API muss Ihren API-Schlüssel enthalten. Pioneer verwendet ein einfaches header-basiertes Schema. Es ist kein OAuth-Flow und kein Token-Austausch erforderlich. Ihr Schlüssel identifiziert Sie und bestimmt, welche Ressourcen und Rate Limits für Ihre Anfragen gelten.

Einen API-Schlüssel erhalten

  1. Melden Sie sich bei pioneer.ai an.
  2. Gehen Sie zu SettingsAPI Keys.
  3. Klicken Sie auf Create key, vergeben Sie einen Namen und kopieren Sie den angezeigten Wert.
Speichern Sie Ihren Schlüssel in einer Umgebungsvariable (zum Beispiel PIONEER_API_KEY), statt ihn in Quelldateien fest zu hinterlegen.

Übergabe Ihres API-Schlüssels

Fügen Sie Ihren Schlüssel bei jeder Anfrage in den X-API-Key-Header ein:
cURL

Schlüssel verwalten

Erstellen Sie neue API-Schlüssel unter Settings -> API Keys im Pioneer-Dashboard. Mit API-Schlüsseln authentifizierte Anfragen können Schlüssel auflisten und widerrufen, aber keine weiteren Schlüssel erstellen.

Einen Schlüssel erstellen

POST /create-api-key wird vom Web-Dashboard verwendet und erfordert eine Browser-Sitzung. Mit X-API-Key authentifizierte Aufrufe geben 403 Forbidden mit der Meldung API key creation is only allowed from the web dashboard. zurück. Die Antwort auf die Erstellung enthält den neuen secret_key-Wert. Kopieren Sie ihn sofort. Er wird kein zweites Mal angezeigt.

Schlüssel auflisten

cURL
Gibt alle Ihrem Konto zugeordneten Schlüssel zurück, einschließlich Namen und Erstellungsdaten. Schlüsselwerte werden in Listenantworten nicht zurückgegeben.

Einen Schlüssel widerrufen

cURL
Widerrufene Schlüssel werden bei der nächsten Anfrage sofort abgelehnt. Ein Rückgängigmachen ist nicht möglich.

Konnektivität testen, bevor Sie einen Schlüssel haben

Um während der Integration zu prüfen, ob Ihr Netzwerk die Pioneer API erreichen kann, senden Sie eine Anfrage mit einem Platzhalterschlüssel. Sie erhalten ein 401 zurück. Das bestätigt, dass der Endpunkt erreichbar und Ihre Anfrage korrekt verdrahtet ist.

Fehlerantworten

Eine 402-Antwort bedeutet, dass das Guthaben Ihres Kontos aufgebraucht ist. Anfragen werden weiterhin fehlschlagen, bis Sie Guthaben hinzufügen oder Ihren Plan aktualisieren. Siehe Pläne & Preise für Ihre Optionen.