Was ist eine API, und brauche ich das?

Sie begegnen den drei Buchstaben im Angebot Ihres Webbauers oder in der Funktionsliste Ihres Buchhaltungsprogramms: API. Dieser Artikel erklärt, was das ist, ohne dass Sie programmieren können müssen.

Die kurze Antwort

Eine API ist eine Tür an der Rückseite Ihres Kontos.

Wo Sie im Verwaltungsbildschirm klicken, um zu sehen, wie viele Plätze noch frei sind, kann ein anderes Programm durch diese Tür genau dasselbe abfragen — ohne dass jemand vor einem Bildschirm sitzt. Hinter beiden Türen stehen dieselben Daten: Ihre Produkte, Ihre Preise, Ihre freien Plätze, Ihr Umsatz.

Der Unterschied liegt darin, wer hereinkommt. Durch die Vordertür kommt ein Mensch mit einer Maus. Durch die Hintertür kommt ein Programm mit einem Schlüssel.

Wann brauchen Sie das?

Nur, wenn Sie etwas wollen, was der Verwaltungsbildschirm nicht kann. Zum Beispiel:

• auf Ihrer eigenen Website zeigen, welche Führungen diese Woche noch Plätze haben, in Ihrer eigenen Gestaltung, mit Zahlen, die in diesem Moment stimmen;
• Ihren Steuerberater mitlesen lassen, damit er den Umsatz des Vormonats selbst abholt, statt jeden Monat einen Export von Ihnen zu bekommen;
• ein Bildschirm in der Eingangshalle, der zeigt, welches Zeitfenster gleich beginnt;
• verkaufen aus einem Programm, das Sie ohnehin nutzen, ohne sich erst im Verwaltungsbildschirm anzumelden.

Und wann brauchen Sie es nicht? Wenn Sie es klicken können. Eine Anbindung zu bauen kostet Zeit und Pflege; zweimal im Monat eine Liste zu exportieren kostet zwei Minuten. Wählen Sie das Erste erst, wenn das Zweite im Weg steht.

Achtung: Sie müssen das nicht selbst bauen. Wer es baut — Ihr Webbauer, der Anbieter Ihres Buchhaltungsprogramms, jemand im Vorstand, der programmieren kann — braucht nur zwei Dinge von Ihnen: die Adresse und einen Schlüssel. Beides finden Sie in Ihrem Verwaltungsbildschirm.

Was Sie genau weitergeben

Öffnen Sie Einstellungen → API-Zugang (dieser Bildschirm ist für den Eigentümer der Organisation da). Auf dem Reiter Schlüssel stehen drei Dinge, die Sie weitergeben können:

1. Die Adresse. Eine Zeile Text. Dorthin spricht das andere Programm.
2. Die technische Beschreibung, der Link, der auf openapi.json endet. Damit sieht ein Entwickler auf einen Blick alles, was möglich ist: welche Daten es gibt, wie man sie abfragt, was zurückkommt.
3. Einen Schlüssel, den Sie selbst anlegen. Siehe Einen API-Schlüssel anlegen.

Mehr braucht er nicht, und mehr sollten Sie auch nicht geben — Ihr Passwort schon gar nicht.

Was ein Schlüssel darf und was nicht

Beim Anlegen haken Sie ab, was der Schlüssel darf. Das ist keine Formsache:

• Lesen — alles abrufen, nichts ändern. Das brauchen die meisten Anbindungen. Beachten Sie: „alles“ sind auch Ihre Bestellungen und Ihre Käufer, mit Name und E-Mail-Adresse.
• Schreiben — Bestellungen anlegen, bezahlen lassen, stornieren und erstatten, eine Rechnung anfordern, Tickets entwerten und erneut senden, Besucher einchecken sowie Gutscheine und Jahreskarten ausstellen, einlösen oder verlängern.
• Webhooks — festlegen, wohin Nachrichten gehen dürfen. Siehe Webhooks.
• Extern bezahlt — eine Bestellung als bezahlt markieren, ohne dass ein Zahlungsanbieter beteiligt war (Überweisung, bar). Geben Sie das nur einer Kasse oder Buchhaltung, die Sie selbst verwalten: Wer das darf, kann Tickets ausgeben, ohne dass Geld hereinkommt.

Geben Sie jeder Anbindung einen eigenen Schlüssel mit genau dem, was sie braucht. Dann können Sie einen widerrufen, ohne den Rest kaputtzumachen, und sehen in der Liste, welcher noch benutzt wird.

Ein Schlüssel ist übrigens kein Passwort, das Ihr Konto öffnet: er gewährt nur das, was auf ihm abgehakt ist, und er gehört zu einer Organisation. Selbst wenn er irgendwo herumliegt, kann damit niemand die Daten eines anderen abrufen.

Erst gefahrlos ausprobieren

Neben einem normalen Schlüssel können Sie einen Testschlüssel anlegen. Er liest genau dieselben Daten. Darf er auch schreiben, legt er nur Testbestellungen an: Sie gehen nie an Ihren Zahlungsanbieter, zählen nicht zu Ihrem Umsatz und werden nach 24 Stunden automatisch entfernt. Webhooks einrichten kann ein Testschlüssel nicht.

Das ist genau für diesen Moment da — jemand probiert etwas aus und weiß noch nicht sicher, was er tut. Lassen Sie Ihren Webbauer mit einem Testschlüssel anfangen und erst am Ende wechseln.

Eines sollten Sie wissen: Auch eine Testbestellung hält einen echten Platz fest (bis sie entfernt wird), und die Bestätigungsmail geht wirklich hinaus. Lassen Sie Ihren Webbauer deshalb mit einem Produkt oder Zeitslot testen, den Sie eigens dafür anlegen.

Und wenn etwas schiefgeht?

Widerrufen Sie den Schlüssel. Klicken Sie in der Liste auf Widerrufen, und ab diesem Moment funktioniert er nicht mehr. Die Anbindung hört auf, Ihre Daten bleiben. Es gibt keine Lage, in der ein Schlüssel etwas anrichten kann, das Sie nicht mit einem Klick stoppen können.

Was es kostet

Die API gehört zu einem größeren Tarif. In einem kleineren steht API-Zugang nicht in Ihrem Menü. Landen Sie trotzdem auf diesem Bildschirm, sehen Sie eine Erklärung, in welchem Tarif die API enthalten ist, und eine Schaltfläche Zum Abonnement — aber keine Schlüssel. Was in welchem Tarif enthalten ist, steht auf der Preisseite von Passavo.

Weiterlesen

• Einen API-Schlüssel anlegen — der Bildschirm selbst, Schritt für Schritt.
• Webhooks — Ihrer Website mitteilen, dass etwas verkauft wurde, ohne dass sie ständig nachfragen muss.
• Webhooks einrichten — der Bildschirm selbst, Schritt für Schritt.
• Das Entwicklerportal — für den, der die Anbindung baut.