TixFinDocs
API-Integration

SDKs

Offizielle Client-Bibliotheken für npm und Python zur Partner-API

2 Min. Lesezeit

TixFin veröffentlicht offizielle Client-Bibliotheken für die Partner-API, damit Sie HTTP-Aufrufe, Seitenabruf und Fehlerbehandlung nicht selbst schreiben müssen.

Beide SDKs decken nur die lesenden Endpunkte der Partner-API ab (Events, Ticketkatalog, Tickets, Bestellungen) – dieselbe Oberfläche, die der API-Überblick beschreibt.

Die SDKs sind noch nicht auf npm oder PyPI veröffentlicht. Bis dahin erhalten Sie Version 0.2.0 über den Support, oder Sie rufen die REST-API direkt auf. Version 0.2.0 passt zur aktuellen API: Sie verwendet standardmäßig https://beta-rest-api.tixfin.com, liest totalItems und totalPages aus der Seitenhülle und gibt das detail der API als Fehlermeldung aus.

TypeScript / JavaScript

Paket: @tixfin/partner-api-client 0.2.0

npm install @tixfin/partner-api-client
import { TixfinPartnerClient } from "@tixfin/partner-api-client";

const client = new TixfinPartnerClient({
  projectId: "YOUR_PROJECT_ID",
  apiKey: process.env.TIXFIN_PARTNER_API_KEY!, // Format "prefix.secret"
  baseUrl: "https://beta-rest-api.tixfin.com",
});

const events = await client.listEvents({ page: 0, size: 20 });
const event = await client.getEvent(events.items[0].id);

const catalog = await client.listTicketCatalog({ eventId: event.id });
const tickets = await client.listTickets({ eventId: event.id, status: "PAID" });
const orders = await client.listOrders({ eventId: event.id });

Mit baseUrl richten Sie den Client auch auf einen anderen Host, etwa eine lokale partner-api unter http://localhost:8087.

Fehlgeschlagene Anfragen werden mit einem TixfinPartnerApiError abgelehnt, der status, message und den unveränderten Antwort-body enthält:

import { TixfinPartnerApiError } from "@tixfin/partner-api-client";

try {
  await client.listEvents();
} catch (error) {
  if (error instanceof TixfinPartnerApiError) {
    console.error(error.status, error.message);
  }
}

Wird als ESM und CJS mit vollständigen TypeScript-Typen ausgeliefert – ein separates @types-Paket ist nicht nötig.

Python

Paket: tixfin-partner-api 0.2.0

pip install tixfin-partner-api
import os
from tixfin_partner_api import TixfinPartnerClient

client = TixfinPartnerClient(
    project_id="YOUR_PROJECT_ID",
    api_key=os.environ["TIXFIN_PARTNER_API_KEY"],  # Format "prefix.secret"
    base_url="https://beta-rest-api.tixfin.com",
)

events = client.list_events(page=0, size=20)
event = client.get_event(events.items[0].id)

catalog = client.list_ticket_catalog(event_id=event.id)
tickets = client.list_tickets(event_id=event.id, status="PAID")
orders = client.list_orders(event_id=event.id)

Mit base_url richten Sie den Client auch auf einen anderen Host, etwa eine lokale partner-api unter http://localhost:8087. Das Zeitlimit pro Anfrage beträgt standardmäßig 10 Sekunden (timeout=).

Fehlgeschlagene Anfragen lösen TixfinPartnerApiError aus, mit status_code, message und dem unveränderten Antwort-body:

from tixfin_partner_api import TixfinPartnerApiError

try:
    client.list_events()
except TixfinPartnerApiError as error:
    print(error.status_code, error.message)

Benötigt Python 3.9 oder neuer; einzige Abhängigkeit ist requests.

Einen Schlüssel wählen

Beide SDKs brauchen einen Partner-API-Schlüssel mit den Endpunktgruppen, die Sie aufrufen – wie Sie einen erstellen, steht unter Authentifizierung. Ruft ein Schlüssel eine Endpunktgruppe auf, die er nicht trägt oder die das Projekt nicht aktiviert hat, endet der Aufruf mit 403. Die status-Filter für Tickets sind PAID, SCANNED, SCANNED_OUT und CANCELLED.

Einstellungen → Integrationen mit den Endpunktgruppen und den Partner-API-Schlüsseln
  1. Integrationen
  2. Endpunktgruppen
  3. API-Schlüssel erstellen
  4. Schlüssel rotieren oder widerrufen
📸 Einstellungen → Integrationen mit den Endpunktgruppen und den Partner-API-Schlüsseln

Kein offizielles SDK für Ihre Sprache?

Jedes SDK ist nur eine dünne Schicht über einfachem HTTP – die Endpunkte finden Sie im API-Überblick, und Sie können sie mit jedem HTTP-Client direkt aufrufen. Aus dem OpenAPI-Dokument unter https://beta-rest-api.tixfin.com/api/partner/openapi.json lässt sich ein Client für jede Sprache erzeugen.

Nächste Schritte

Auf dieser Seite