Spedy Docs

Alle API-Anfragen erfordern Authentifizierung via Personal Access Token (PAT). PATs bieten langlebigen API-Zugriff für Skripte, CI/CD-Pipelines und Integrationen. Sie erben die Berechtigungen des Nutzers, der sie erstellt hat.

PATs erfordern ein Pro-Plan-Abonnement.

Token erstellen

Offne Einstellungen > Konto > Access Tokens im Spedy-Dashboard.
Klicke auf Token erstellen und vergib einen beschreibenden Namen (z.B. "CI Pipeline" oder "Zapier Integration").
Kopiere das Token sofort -- es wird nur einmal angezeigt und kann danach nicht mehr abgerufen werden.

Token verwenden

Fuege das Token im Authorization-Header jeder API-Anfrage ein:

curl -H "Authorization: Bearer spedy_pat_abc123def456..." \
  https://acme-corp.spedy.app/api/v1/tickets

Das Token ist auf die Organisation des Nutzers beschraenkt, der es erstellt hat. Alle Anfragen werden mit den Berechtigungen dieses Nutzers ausgefuehrt.

Token-Format und Sicherheit

Tokens beginnen mit dem Praefix spedy_pat_ zur einfachen Identifikation.
Behandle Tokens wie Passwoerter -- committe sie niemals in die Versionskontrolle und teile sie nicht im Klartext.
Verwende Umgebungsvariablen oder einen Secrets-Manager, um Tokens in CI/CD-Pipelines zu speichern.
Widerrufe Tokens, die du nicht mehr benoetigst.

Token-Verwaltungs-Endpunkte

Tokens auflisten

GET /api/v1/me/tokens

Gibt alle aktiven Tokens des aktuellen Nutzers zurueck.

Beispiel-Response

{
  "tokens": [
    {
      "id": "tok_abc123",
      "name": "CI Pipeline",
      "lastUsedAt": "2025-03-15T10:30:00Z",
      "createdAt": "2025-01-10T08:00:00Z"
    }
  ]
}

Token erstellen

POST /api/v1/me/tokens

Erstelle ein neues Personal Access Token. Der vollstaendige Token-Wert wird nur einmal in der Antwort zurueckgegeben -- speichere ihn sicher.

Request Body

Feld	Typ	Pflicht	Beschreibung
name	string	Ja	Ein beschreibender Name fuer das Token

Beispiel-Request

{
  "name": "CI Pipeline"
}

Beispiel-Response

{
  "id": "tok_abc123",
  "name": "CI Pipeline",
  "token": "spedy_pat_abc123def456...",
  "createdAt": "2025-03-20T14:00:00Z"
}

Token abrufen

GET /api/v1/me/tokens/{tokenId}

Details eines bestimmten Tokens abrufen (ohne den geheimen Wert).

Token widerrufen

DELETE /api/v1/me/tokens/{tokenId}

Ein Token dauerhaft widerrufen. Diese Aktion kann nicht rueckgaengig gemacht werden. Gibt 204 No Content bei Erfolg zurueck.

OAuth 2.0

Fuer externe Anwendungen wie KI-Tools, IDE-Erweiterungen und MCP-faehige Clients unterstuetzt Spedy auch OAuth 2.0 mit PKCE. OAuth ist auf allen Plaenen verfuegbar (einschliesslich Starter und Trial) und ist die empfohlene Authentifizierungsmethode fuer Drittanbieter-Integrationen.

Siehe die OAuth-2.0-Seite fuer die vollstaendige Referenz.

Authentifizierung

Inhaltsverzeichnis