Zum Hauptinhalt springen
Logo der CaptiFi REST API
Entwickler-Integration

CaptiFi REST API + CaptiFi

Übertragen Sie Ihre Standorte, Gästeanmeldungen und Besuchsstatistiken in jedes System, mit einer schreibgeschützten REST-API und selbst erstellten Schlüsseln. Ab Growth enthalten. Kostenlose Testphase.

Übersicht

Was macht die Integration der CaptiFi REST API?

Die CaptiFi-REST-API ist eine reine Lese-API im JSON-Format über dieselben Gästedaten, die Ihr Dashboard zeigt: Betriebe, Gästeanmeldungen und Besuchsstatistiken, mit Self-Service-Schlüsseln, die Sie selbst erstellen und widerrufen. Schlüssel werden gehasht gespeichert und nur einmal angezeigt, Sie können bis zu fünf haben, und nichts, was ein Schlüssel tun kann, ändert Ihre Einstellungen oder Datensätze. Für individuell entwickelte Buchungsplattformen, hauseigene CRMs, Data Warehouses und Reporting-Tabellen. Im Growth-Tarif und höher enthalten.

Die CaptiFi-REST-API ist für die Systeme da, die kein Verzeichnis abdecken kann: eine individuell entwickelte Buchungsplattform, ein hauseigenes CRM, ein Data Warehouse, eine Reporting-Tabelle, in der ein Finanzteam ohnehin arbeitet. Statt Sie jede Woche um einen CSV-Export zu bitten, gibt CaptiFi Ihnen eine reine Lese-API im JSON-Format über dieselben Gästedaten, die Ihr Dashboard zeigt, mit Self-Service-Schlüsseln, die Sie selbst erstellen und widerrufen.

Erstellen Sie im Dashboard einen Schlüssel, benennen Sie ihn nach dem System, das ihn verwenden wird, und senden Sie ihn als Bearer-Token an https://app.captifi.io/api/v1/customer. Vier Endpunkte decken alles ab: /venues für Ihre Standorte, /guests für Anmeldungen mit Filterung und Paginierung, /stats für Besuchs- und Opt-in-Summen über einen Zeitraum und /me, um zu bestätigen, zu welchem Konto ein Schlüssel gehört. Jede Antwort hat dieselbe Struktur, mit Ihren Zeilen unter data und Paginierung oder Summen unter meta, sodass ein einziger Client alle verarbeiten kann.

Die API ist bewusst nur lesend. Nichts, was ein Schlüssel tun kann, ändert Ihre Splash-Seiten, Ihre Einstellungen oder Ihre Gästedatensätze. Deshalb können Sie ihn gefahrlos einem Entwickler oder einer Agentur geben, ohne Ihr Dashboard aus der Hand zu geben. Schlüssel werden wie Passwörter gehasht gespeichert und genau einmal angezeigt, Sie können bis zu fünf gleichzeitig haben, und der Widerruf eines Schlüssels wirkt sich nie auf die anderen aus. Kombinieren Sie die API mit Webhooks: Webhooks für Live-Ereignisse, wenn Gäste eintreffen, die API, um die Historie nachzuladen und Berichte zu erstellen.

Konten mit Growth und höher können mit denselben Schlüsseln auch ihr Prämienprogramm auslesen: das Programm und seine Betriebe, Mitglieder, das Punktekonto jedes Mitglieds, ausgegebene Prämien, Einlösungen und Angebote, alles unter /api/v1/customer/rewards. Die Ergebnisse kommen mit den neuesten zuerst und der üblichen Paginierung und lassen sich nach E-Mail-Adresse oder Telefonnummer des Mitglieds, Stufe, Status, Angebot, Betrieb oder Zeitfenster eingrenzen. Auch diese Endpunkte sind nur lesend und richten sich nach dem Prämien-Schalter und dem Tarif des Kontos. Kassen und Kioske verwenden einen separaten Terminal-Schlüssel für /api/v1/rewards-pos, um einen Prämiencode gegen die Rechnung zu prüfen, ihn einmalig mit einer Referenz für den Beleg einzulösen, diesen Verkauf innerhalb von 30 Minuten zu stornieren, ein Mitglied nachzuschlagen oder Punkte für einen Verkauf zu vergeben. Jede Einlösung trägt einen Idempotency-Key, sodass eine Kasse, die es nach einem Verbindungsabbruch erneut versucht, dieselbe Antwort zurückbekommt statt einer zweiten Einlösung.

Was Sie bekommen

Warum die CaptiFi REST API mit CaptiFi verbinden

Ihre Gästedaten in Ihren eigenen Systemen

Übernehmen Sie Standorte, Gästeanmeldungen und Besuchsstatistiken direkt in eine Buchungsplattform, ein CRM, ein Data Warehouse oder ein Reporting-Tool, ohne wöchentlichen CSV-Export und ohne darauf zu warten, dass ein nativer Connector gebaut wird.

Bewusst schreibgeschützt

Ein Schlüssel kann Ihre Daten lesen und sonst nichts. Er kann keine Splash-Seiten bearbeiten, keine Einstellungen ändern und keine Gästedatensätze anfassen, sodass die Weitergabe an einen Entwickler oder eine Agentur keines der Risiken birgt, die das Teilen eines Dashboard-Logins mit sich bringt.

Schlüssel in Selbstverwaltung, einzeln widerrufbar

Erstellen Sie selbst bis zu fünf Schlüssel, einen pro System, damit Sie eine einzelne Integration stilllegen oder ihren Schlüssel erneuern können, ohne die übrigen zu unterbrechen. Schlüssel werden gehasht gespeichert und nur einmal angezeigt, genau wie ein Passwort.

Ein vorhersehbares Antwortformat

Jeder Endpunkt gibt Zeilen unter data und Paginierung oder Summen unter meta zurück, sodass der Client, den Sie für Gäste schreiben, unverändert für Standorte und Statistiken funktioniert.

Welche Daten zur CaptiFi REST API fließen

Ihre Standorte und deren Kennungen
Gästeanmeldungen: Name, E-Mail, Telefon, sofern erfasst
Status der Marketing- und Kontakteinwilligung pro Gast
Datum des ersten und des letzten Besuchs, Anzahl der Besuche
Besuchs- und Opt-in-Gesamtsummen für jeden von Ihnen gewünschten Zeitraum
Das Konto und der Tarif, zu dem ein Schlüssel gehört
Wie es funktioniert

In wenigen Minuten einsatzbereit

1

Einen API-Schlüssel erstellen

Öffnen Sie „API-Schlüssel“ in Ihrem CaptiFi-Dashboard und geben Sie dem Schlüssel einen Namen, der zu dem System passt, das ihn verwenden wird. Der Schlüssel erscheint nur einmal, unmittelbar nach der Erstellung, kopieren Sie ihn also sofort: Er wird gehasht gespeichert und kann nicht erneut angezeigt werden.

2

Authentifizieren Sie Ihre Anfragen

Senden Sie den Schlüssel als Header Authorization: Bearer zusammen mit Accept: application/json an die Basis-URL https://app.captifi.io/api/v1/customer.

3

Rufen Sie die benötigten Endpunkte auf

Nutzen Sie /venues für Ihre Standorte, /guests für Anmeldungen mit Filtern und Paginierung, /stats für Besuchs- und Opt-in-Summen und /me, um das Konto zu bestätigen. Antworten enthalten immer Zeilen unter data und Paginierung unter meta.

4

Webhooks für Live-Ereignisse hinzufügen

Nutzen Sie die API, um die Historie abzurufen und Berichte nach Ihrem eigenen Zeitplan zu erstellen, und fügen Sie einen Webhook-Endpunkt hinzu, damit neue Anmeldungen in der Sekunde, in der sie passieren, an Sie gesendet werden statt erst bei Ihrer nächsten Abfrage.

Lesen Sie die Einrichtungsanleitung zur CaptiFi REST API

Schritt für Schritt, mit Screenshots.

In der Praxis

Wie Betriebe die CaptiFi REST API mit CaptiFi nutzen

Hotelgruppe

Eine Gruppe lädt die Gästeanmeldungen jede Nacht in ihr eigenes Data Warehouse, sodass WLAN-Opt-ins neben Buchungen und Umsätzen in derselben Reporting-Umgebung liegen.

Restaurantkette

Ein internes CRM ruft /guests jede Stunde mit einem Datumsfilter auf, sodass neue Restaurantgäste mit Opt-in in den Tools des Marketingteams erscheinen, ohne dass jemand eine Tabelle exportiert.

Agentur

Eine Marketingagentur erhält pro Kunde einen eigenen Nur-Lese-Schlüssel, baut aus /stats ein Live-Dashboard für Besucherzahlen und Opt-ins, und der Betrieb kann diesen einen Schlüssel am Ende der Zusammenarbeit widerrufen.

FAQ

Häufig gestellte Fragen

Welche Tarife enthalten die CaptiFi API?
Die API ist im Growth-Tarif und höher ohne Aufpreis enthalten, zusammen mit Webhooks. Eine 30-tägige kostenlose Testphase, die mit Growth oder Pro gestartet wird, enthält sie, sodass Sie schon während der Testphase damit entwickeln können. Mit Essentials erklärt die Seite „API-Schlüssel“ weiterhin, was die API kann und wie Sie upgraden.
Kann die API irgendetwas in meinem Konto ändern?
Nein. Die Kunden-API ist schreibgeschützt. Schlüssel können Standorte, Gäste und Statistiken lesen und können Ihre Splash-Seiten, Einstellungen oder Gästedatensätze nicht ändern. Deshalb können Sie einen Schlüssel bedenkenlos an einen Entwickler oder eine Agentur weitergeben.
Wie viele Schlüssel kann ich haben, und was, wenn ich einen verliere?
Sie können bis zu fünf Schlüssel gleichzeitig haben, und mit einem eigenen Schlüssel pro System können Sie einen widerrufen, ohne die anderen zu unterbrechen. Schlüssel werden gehasht gespeichert und nur einmal bei der Erstellung angezeigt. Wenn Sie also einen verlieren, widerrufen Sie ihn und erstellen Sie einen neuen.
Sollte ich die API oder Webhooks verwenden?
Nutzen Sie Webhooks, wenn Sie auf einen Gast reagieren möchten, sobald er eintrifft, und Ihr System eine eingehende HTTPS-Anfrage annehmen kann. Nutzen Sie die API, wenn Sie eine Liste nach Ihrem eigenen Zeitplan abrufen möchten oder wenn Ihr System nur ausgehende Anfragen stellen kann. Viele Setups nutzen beides: Webhooks für Live-Ereignisse, die API zum Nachladen der Historie.
Kann ich mein Prämienprogramm über die API auslesen?
Ja, im Tarif Growth und höher, mit denselben Schlüsseln: das Programm und seine Standorte, Mitglieder, das Punktekonto jedes Mitglieds, ausgegebene Prämien, Einlösungen und Angebote unter /api/v1/customer/rewards, schreibgeschützt und abhängig von Ihrem Rewards-Schalter und Ihrem Tarif. Eine Kasse oder ein Kiosk, die einlösen müssen, verwenden einen separaten Terminal-Schlüssel für /api/v1/rewards-pos, mit einem Idempotency-Key bei jeder Einlösung, sodass ein erneuter Versuch nie doppelt einlöst.
Wo befindet sich die Endpunktreferenz?
Die vollständige Referenz, einschließlich Authentifizierung, Filter, Paginierung und Beispielantworten, finden Sie in der CaptiFi-Dokumentation auf docs.captifi.io unter Dashboard, API.

Nutzen Sie die CaptiFi REST API noch heute mit CaptiFi

30-tägige kostenlose Testphase. Jederzeit kündbar.

Google, Gmail, Mailchimp, Klaviyo, HubSpot, Salesforce, Facebook, Meta Pixel, Slack, Zapier, Twilio, Tripadvisor, Yelp, Trustpilot, Untappd, Feefo, REVIEWS.io, Yotpo, Toast, Square, SumUp, Airship, Revinate, Leat, Pepper, EmailOctopus, MailerLite und Incentivio sind Marken ihrer jeweiligen Eigentümer und erscheinen hier nur, um die Dienste zu identifizieren, mit denen CaptiFi verbunden ist. CaptiFi ist unabhängig von diesen Unternehmen und wird von ihnen nicht gesponsert, zertifiziert oder unterstützt. Eine als „demnächst verfügbar“ gekennzeichnete Integration steht auf unserer Roadmap und ist noch nicht verfügbar. Twilio und alle damit verbundenen Logos sind Markenzeichen von Twilio Inc. oder deren Tochtergesellschaften. Salesforce ist eine Marke von Salesforce, Inc. Slack ist eine Marke und Dienstleistungsmarke von Slack Technologies, Inc., die in den USA und in anderen Ländern registriert ist.

CaptiFi ist eine Plattform für Gäste-WLAN-Marketing und Captive Portal für Restaurants, Bars, Pubs, Cafés, Hotels, Fitnessstudios, Salons, den Einzelhandel und Kurzzeitvermietungen, entwickelt von CaptiFi Ltd im Vereinigten Königreich und in GBP, USD, EUR, CAD, AUD und NZD an Betriebe weltweit verkauft.