CaptiFi REST API + CaptiFi
Haal je locaties, gastaanmeldingen en bezoekstatistieken binnen in elk systeem met een alleen-lezen REST API en sleutels die je zelf aanmaakt. Inbegrepen vanaf Growth. Gratis proefperiode.
Wat doet de integratie met de CaptiFi REST API?
De CaptiFi REST API is een alleen-lezen JSON-API op dezelfde gastgegevens die je dashboard toont: locaties, gastaanmeldingen en bezoekstatistieken, met sleutels die je zelf aanmaakt en intrekt. Sleutels worden gehasht opgeslagen en één keer getoond, je kunt er maximaal vijf hebben, en niets wat een sleutel kan doen verandert je instellingen of records. Voor eigen boekingsplatforms, interne CRM's, datawarehouses en rapportagespreadsheets. Inbegrepen vanaf het Growth-abonnement.
De CaptiFi REST API is er voor de systemen die geen enkel integratieoverzicht kan afdekken: een eigen boekingsplatform, een intern CRM, een datawarehouse, een rapportagespreadsheet waar een financeteam al dagelijks in werkt. In plaats van je elke week een CSV te laten exporteren, geeft CaptiFi je een alleen-lezen JSON-API op dezelfde gastgegevens die je dashboard toont, met sleutels die je zelf aanmaakt en intrekt.
Maak een sleutel aan in het dashboard, noem hem naar het systeem dat hem gaat gebruiken en stuur hem als bearer-token naar https://app.captifi.io/api/v1/customer. Vier endpoints dekken alles af: /venues voor je locaties, /guests voor aanmeldingen met filters en paginering, /stats voor bezoek- en opt-in-totalen over een periode, en /me om te bevestigen bij welk account een sleutel hoort. Elk antwoord komt terug in dezelfde envelop, met je rijen onder data en paginering of totalen onder meta, zodat één client ze allemaal aankan.
De API is bewust alleen-lezen. Niets wat een sleutel kan doen verandert je inlogpagina's, je instellingen of je gastrecords. Daardoor kun je hem veilig aan een ontwikkelaar of een bureau geven zonder je dashboard uit handen te geven. Sleutels worden gehasht opgeslagen zoals wachtwoorden en precies één keer getoond, je kunt er maximaal vijf tegelijk hebben, en een sleutel intrekken heeft nooit gevolgen voor de andere. Combineer de API met webhooks: webhooks voor live gebeurtenissen op het moment dat gasten binnenkomen, de API om historie aan te vullen en rapporten te bouwen.
Accounts op Growth en hoger kunnen met dezelfde sleutels ook hun Rewards-programma uitlezen: het programma en de locaties ervan, leden, het puntenoverzicht van elk lid, uitgegeven beloningen, verzilveringen en aanbiedingen, allemaal onder /api/v1/customer/rewards. Resultaten komen met de nieuwste eerst, met de gebruikelijke paginering, en zijn te verfijnen op e-mailadres of telefoonnummer van het lid, niveau, status, aanbieding, locatie of een tijdvak. Ook die endpoints zijn alleen-lezen en volgen de Rewards-schakelaar en het abonnement van het account. Kassa's en kiosken gebruiken een aparte terminalsleutel op /api/v1/rewards-pos om een beloningscode tegen de rekening te controleren, hem één keer te verzilveren met een referentie voor de bon, die verkoop binnen 30 minuten terug te draaien, een lid op te zoeken of punten toe te kennen voor een verkoop. Elke verzilvering heeft een Idempotency-Key, zodat een kassa die het na een weggevallen verbinding opnieuw probeert hetzelfde antwoord terugkrijgt in plaats van een tweede verzilvering.
Waarom de CaptiFi REST API aan CaptiFi koppelen
Je gastgegevens in je eigen systemen
Haal locaties, gastaanmeldingen en bezoekstatistieken rechtstreeks binnen in een boekingsplatform, CRM, datawarehouse of rapportagetool, zonder wekelijkse CSV-export en zonder te wachten tot er een native connector is gebouwd.
Alleen-lezen van opzet
Een sleutel kan je gegevens lezen en verder niets. Hij kan geen inlogpagina's bewerken, geen instellingen wijzigen en niet aan gastrecords komen, dus als je er een aan een ontwikkelaar of bureau geeft, loop je niet het risico dat bij het delen van een dashboardlogin hoort.
Sleutels die je zelf aanmaakt en één voor één intrekt
Maak zelf maximaal vijf sleutels aan, één per systeem, zodat je één integratie kunt stopzetten of van een nieuwe sleutel voorzien zonder de rest te breken. Sleutels worden gehasht opgeslagen en één keer getoond, precies zoals een wachtwoord.
Eén voorspelbare antwoordvorm
Elk endpoint geeft rijen terug onder data en paginering of totalen onder meta, dus de client die je voor gasten schrijft werkt ongewijzigd voor locaties en statistieken.
Welke gegevens naar de CaptiFi REST API gaan
Binnen enkele minuten aan de slag
Een API-sleutel aanmaken
Open API-sleutels in je CaptiFi-dashboard en geef de sleutel een naam die past bij het systeem dat hem gaat gebruiken. De sleutel verschijnt één keer, direct na het aanmaken, dus kopieer hem meteen: hij wordt gehasht opgeslagen en kan niet opnieuw worden getoond.
Authenticeer je verzoeken
Stuur de sleutel als Authorization: Bearer-header, met Accept: application/json, naar de basis-URL https://app.captifi.io/api/v1/customer.
Roep de endpoints aan die je nodig hebt
Gebruik /venues voor je locaties, /guests voor aanmeldingen met filters en paginering, /stats voor bezoek- en opt-in-totalen, en /me om het account te bevestigen. Antwoorden hebben altijd rijen onder data en paginering onder meta.
Voeg webhooks toe voor live gebeurtenissen
Gebruik de API om op je eigen momenten historie op te halen en rapporten te bouwen, en voeg een webhook-endpoint toe zodat nieuwe aanmeldingen naar je worden gestuurd op de seconde dat ze gebeuren, niet pas bij je volgende poll.
Stap voor stap, met screenshots.
Zo gebruiken zaken de CaptiFi REST API met CaptiFi
Een groep haalt gastaanmeldingen elke nacht binnen in het eigen datawarehouse, zodat wifi-opt-ins in dezelfde rapportageomgeving naast boekingen en bestedingen staan.
Een intern CRM roept elk uur /guests aan met een datumfilter, zodat nieuwe restaurantgasten met een opt-in in de tools van het marketingteam verschijnen zonder dat iemand een spreadsheet exporteert.
Een marketingbureau krijgt per klant een eigen alleen-lezen sleutel en bouwt met /stats een live dashboard met bezoekersaantallen en opt-ins, en de zaak kan die ene sleutel intrekken als de opdracht afloopt.
Veelgestelde vragen
Welke abonnementen bevatten de CaptiFi-API?
Kan de API iets wijzigen in mijn account?
Hoeveel sleutels kan ik hebben, en wat als ik er een kwijtraak?
Moet ik de API of webhooks gebruiken?
Kan ik mijn Rewards-programma uitlezen via de API?
Waar staat de endpointreferentie?
Begin vandaag met de CaptiFi REST API en CaptiFi
Gratis proefperiode van 30 dagen. Altijd opzegbaar.
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 en Incentivio zijn handelsmerken van hun respectieve eigenaren en staan hier alleen om de diensten aan te duiden waarmee CaptiFi koppelt. CaptiFi is onafhankelijk van deze bedrijven en wordt niet door hen gesponsord, gecertificeerd of goedgekeurd. Een integratie met de vermelding binnenkort staat op onze roadmap en is nog niet beschikbaar. Twilio en alle bijbehorende logo's zijn handelsmerken van Twilio Inc. of haar gelieerde ondernemingen. Salesforce is een handelsmerk van Salesforce, Inc. Slack is een handelsmerk en dienstmerk van Slack Technologies, Inc., geregistreerd in de VS en in andere landen.
CaptiFi is een platform voor gastenwifimarketing en captive portals voor restaurants, bars, pubs, koffiebars, hotels, sportscholen, salons, winkels en vakantieverhuur, gemaakt door CaptiFi Ltd in het Verenigd Koninkrijk en verkocht in GBP, USD, EUR, CAD, AUD en NZD aan zaken over de hele wereld.