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.
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.
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
In wenigen Minuten einsatzbereit
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.
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.
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.
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.
Schritt für Schritt, mit Screenshots.
Wie Betriebe die CaptiFi REST API mit CaptiFi nutzen
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.
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.
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.
Häufig gestellte Fragen
Welche Tarife enthalten die CaptiFi API?
Kann die API irgendetwas in meinem Konto ändern?
Wie viele Schlüssel kann ich haben, und was, wenn ich einen verliere?
Sollte ich die API oder Webhooks verwenden?
Kann ich mein Prämienprogramm über die API auslesen?
Wo befindet sich die Endpunktreferenz?
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.