Skip to main content
POST
Erstellt einen neuen Management-API-Schlüssel. Dieser Endpunkt befindet sich auf dem regulären Scanova-API-Host (qcg-api.scanova.io) und wird auf dieselbe Weise authentifiziert wie jede andere eingeloggte Dashboard-Anfrage — ein OAuth-Access-Token, nicht ein Management-API-Schlüssel.
Dies ist der einzige Management-API-bezogene Aufruf, den Sie aus einem vertrauenswürdigen Kontext heraus mit Ihrem eigenen Login tätigen, nicht aus der Integration, die den entstehenden Schlüssel später verwenden wird. Die vollständige Zwei-Host-Architektur finden Sie in der Übersicht.

Anfrage

Body-Parameter

string
erforderlich
Eine für Menschen lesbare Bezeichnung für den Schlüssel, z. B. "Zapier — production". Wird in der Schlüsselliste des Dashboards angezeigt, damit Sie Schlüssel auseinanderhalten können.
string
Standard:"sandbox"
Einer von sandbox, live, zapier, mcp. Für die Lebensdauer des Schlüssels dauerhaft festgelegt — bestimmt, welche Plan-Quota bei jeder Anfrage des Schlüssels an den Daten-Host geprüft wird, und bei zapier-/mcp-Schlüsseln, welchen User-Agent-Header der aufrufende Client senden muss. Die vollständige Zuordnung finden Sie unter Plan-Quota.
integer
Standard:"-1"
Einer von -1 (Nie), 30, 90 oder 365 — Tage nach der Erstellung, nach denen der Schlüssel nicht mehr funktioniert. Es gibt keine Möglichkeit, die Ablaufzeit eines bestehenden Schlüssels zu verlängern; erstellen Sie stattdessen einen neuen.

Antwortfelder

string
Der rohe Management-API-Schlüssel. Dies ist die einzige Antwort, die jemals den vollständigen Schlüsselwert zurückgibt — es gibt keinen Anzeige-/Abruf-Endpunkt im Nachhinein, speichern Sie ihn also sofort.
string | null
Der absolute Ablaufzeitpunkt, berechnet aus created + expiry Tagen, oder null, wenn expiry gleich -1 (Nie) ist.
boolean
Ob der Schlüssel sein expiry_date bereits überschritten hat. Abgelaufene Schlüssel scheitern bei der Authentifizierung am Daten-Host, werden aber nicht automatisch gelöscht — entfernen Sie sie explizit über DELETE /console/token/{key}/, wenn Sie sie aus der Liste entfernen möchten.
integer
Lebenszeit-Zähler der mit diesem konkreten Schlüssel gestellten Anfragen, über seine gesamte Historie. Dies unterscheidet sich von den aggregierten, environment-weiten Werten, die von den Nutzungs-Endpunkten unten zurückgegeben werden, welche über alle Schlüssel summieren, die dieses Environment teilen.

Bestehende Token auflisten

Derselbe Pfad console/token/ akzeptiert außerdem GET (ohne Body), um alle Schlüssel des Kontos aufzulisten, wobei für jeden dieselbe Struktur wie bei der Erstellungsantwort zurückgegeben wird. Sie können nach Environment filtern: GET /console/token/?environment=live.
Sowohl Erstellen als auch Auflisten von Token prüfen die Plan-Quota erneut anhand des environment der Anfrage — das Body-Feld beim Erstellen, der Query-Parameter beim Auflisten, standardmäßig sandbox, falls weggelassen. Wenn sich die Sandbox- und Live-Quoten Ihres Plans unterscheiden, geben Sie beim Auflisten von Live-Environment-Schlüsseln explizit ?environment=live an, da sonst standardmäßig die Sandbox-Quota geprüft wird.

Verwandte Themen

Autorisierungen

Authorization
string
header
erforderlich

Send your Management API key as the raw value of the Authorization header — no "Bearer " or "Token " prefix, and no other characters. Example: Authorization: 401f7ac837da42b97f613d789819ff93537bee6a. A header containing more than one space-separated part is rejected outright. Requests also require the request's Host header to be the management API host (e.g. management.scanova.io) — the same key sent to the regular API host will not authenticate.

Antwort

201

Token created