Zum Inhalt springen
TixFin

API-Dokumentation

Vollständige API- Referenz

REST API mit OpenAPI-Dokumentation, typisierten Antworten und offiziellen Clients für TypeScript und Python.

API-Zugang anfragenAPI-Clients

Nur lesend

Kern- Endpunkte

Alle Endpunkte, die die Partner-API heute bereitstellt, unter einem projektbezogenen Basispfad. Listen sind mit page und size paginiert (bis zu 100 pro Seite).

Basispfad
/api/partner/projects/{projectId}
  • GET/events

    Listet die Events des Projekts mit Zeitplan, Status und Verkaufsstand.

    Key-Scope: events.read

  • GET/events/{eventId}

    Ruft ein Event ab, inklusive Verkaufspause, Operations-Hinweis und Erstattungsfrist.

    Key-Scope: events.read

  • GET/ticket-catalog?eventId=

    Listet Tickettypen mit Preis, Währung, Kontingent, Verkaufsstart und Gültigkeit.

    Key-Scope: ticket_catalog.read

  • GET/tickets?eventId=&paymentReference=&status=

    Listet ausgestellte Tickets, filterbar nach Event, Zahlungsreferenz und Status.

    Key-Scope: tickets.read

  • GET/orders?eventId=

    Listet Bestellungen nach Zahlungsreferenz gruppiert, mit Summe, Ticketanzahl und Status.

    Key-Scope: orders.read

Authentifizierung

Ein Key, ein Projekt

API-Keys werden je Projekt unter Einstellungen → Integrationen erstellt und einmalig im Format prefix.secret angezeigt.

  • Sende den Key als X-API-Key-Header oder als Authorization: Bearer-Token.
  • Jeder Key ist auf Endpunktgruppen beschränkt; ein Aufruf außerhalb seines Scopes liefert 403.
  • Keys lassen sich jederzeit rotieren oder widerrufen — jede Änderung steht im Audit-Log.
request.shShell
curl "https://rest-api.tixfin.com/api/partner/projects/{projectId}/events?page=0&size=20" \
  -H "X-API-Key: YOUR_API_KEY"

Eingebaut

API- Funktionen

  • REST API

    Saubere, lesende RESTful-Endpunkte mit konsistenten Konventionen über alle Ressourcen hinweg.

  • API-Key-Authentifizierung

    Projektbezogene Keys mit Berechtigungen je Endpunktgruppe, Rotation und Widerruf.

  • Paginierung

    Jede Liste liefert Einträge mit total, page und size — so bleiben große Exporte vorhersehbar.

  • Rate Limiting

    Limits pro IP und pro API-Key schützen die Plattform. Großzügige Limits für Standardnutzung.

  • OpenAPI-Spec

    Ein vollständiges OpenAPI-Schema und Swagger UI direkt aus der API — die Quelle, aus der beide offiziellen Clients gebaut sind.

  • Strukturierte Fehler

    Konsistente JSON-Fehlerantworten mit HTTP-Status und aussagekräftiger Nachricht.

Bereit zur Integration?

Während der Beta schalten wir die Partner-API je Projekt frei. Erzähl uns, was du anbinden möchtest.