CaptiFi REST API + CaptiFi
Récupérez vos lieux, inscriptions d’invités et statistiques de visite dans n’importe quel système disposant d’une API REST en lecture seule et des clés en libre-service. Inclus sur Growth et versions supérieures. Essai gratuit.
Que fait l’intégration de l’API REST de CaptiFi ?
The CaptiFi REST API is a read-only JSON API over the same guest data your dashboard shows: venues, guest sign-ups and visit statistics, with self-serve keys you create and revoke yourself. Keys are stored hashed and shown once, you can hold up to five, and nothing a key can do changes your settings or records. For bespoke booking platforms, in-house CRMs, data warehouses and reporting spreadsheets. Included on the Growth plan and above.
L’API REST de CaptiFi existe pour les systèmes qu’aucun annuaire ne peut couvrir : une plateforme de réservation sur mesure, un CRM interne, un entrepôt de données, un tableau de reporting dans lequel une équipe financière évolue déjà. Plutôt que de vous demander d’exporter un CSV chaque semaine, CaptiFi vous propose une API JSON en lecture seule sur les mêmes données invités que votre tableau de bord, avec des clés en libre-service que vous créez et révoquez vous-même.
Create a key in the dashboard, name it after the system that will use it, and send it as a bearer token against https://app.captifi.io/api/v1/customer. Four endpoints cover the ground: /venues for your sites, /guests for sign-ups with filtering and pagination, /stats for visit and opt-in totals over a period, and /me to confirm which account a key belongs to. Every response comes back in the same envelope, with your rows under data and paging or totals under meta, so a single client handles all of them.
L’API est délibérément en lecture seule. Rien de ce qu’une clé peut faire ne changera vos pages de démarrage, vos paramètres ou vos enregistrements invités, ce qui la rend sûre à remettre à un développeur ou à une agence sans avoir à remettre votre tableau de bord. Les clés sont stockées, hachées comme des mots de passe et révélées une seule fois, vous pouvez en tenir jusqu’à cinq à la fois, et en révoquer une n’affecte jamais les autres. Associez l’API à des webhooks : des webhooks pour les événements en direct à l’arrivée des invités, l’API pour remplir l’historique et créer des rapports.
Accounts on Growth and above can also read their Rewards programme with the same keys: the programme and its venues, members, each member's points ledger, issued rewards, redemptions and offers, all under /api/v1/customer/rewards. Results come newest first with the usual paging and can be narrowed by member email or phone, tier, status, offer, venue or a time window. Those endpoints are read-only too and follow the account's Rewards switch and plan. Tills and kiosks use a separate terminal key against /api/v1/rewards-pos to check a reward code against the bill, redeem it once with a reference for the receipt, reverse that sale within 30 minutes, look up a member or award points for a sale. Every redeem carries an Idempotency-Key, so a till that retries after a dropped connection gets the same answer back instead of a second redemption.
Pourquoi connecter l’API REST de CaptiFi à CaptiFi
Vos données invités dans vos propres systèmes
Rassemblez les lieux, les inscriptions d’invités et les statistiques de visite directement dans une plateforme de réservation, un CRM, un entrepôt ou un outil de rapport, sans export CSV hebdomadaire et sans attendre la création d’un connecteur natif.
Lecture seule par conception
Une clé ne peut lire vos données et rien d’autre. Elle ne peut pas modifier les pages d’accueil, modifier les paramètres ou toucher les enregistrements invités, donc en remettre une à un développeur ou une agence n’implique aucun risque de partage d’un identifiant sur un tableau de bord.
Clés en libre-service, révocables une par une
Créez jusqu’à cinq clés vous-même, une par système, afin de pouvoir retirer ou faire tourner une seule intégration sans casser les autres. Les clés sont stockées hachées et affichées une seule fois, exactement comme un mot de passe.
Une forme de réponse prévisible
Chaque terminaison renvoie des lignes sous données et paginage ou totaux sous méta, donc le client que vous écrivez pour les invités fonctionne inchangé pour les lieux et les statistiques.
Quelles données sont transférées à l’API REST de CaptiFi
Prêt en quelques minutes
Créer une clé API
Ouvrez les clés API dans votre tableau de bord CaptiFi et donnez à la clé un nom correspondant au système qui l’utilisera. La clé apparaît une fois, immédiatement après la création, alors copiez-la immédiatement : elle est stockée hachée et ne peut plus être réaffichée.
Authentifier vos demandes
Envoyez la clé sous forme d’en-tête Authorization : Bearer, avec Accept : application/json, sur l’URL de base https://app.captifi.io/api/v1/customer.
Appelez les points de terminaison dont vous avez besoin
Use /venues for your sites, /guests for sign-ups with filters and pagination, /stats for visit and opt-in totals, and /me to confirm the account. Responses always carry rows under data and paging under meta.
Ajouter des webhooks pour les événements en direct
Utilisez l’API pour extraire l’historique et construire des rapports selon votre propre planning, et ajoutez un point de terminaison webhook pour que les nouvelles inscriptions vous soient transmises dès qu’elles se produisent plutôt que lors de votre prochain sondage.
Étape par étape, avec des captures d’écran.
Comment les lieux utilisent l’API REST de CaptiFi avec CaptiFi
Un groupe regroupe chaque soir les inscriptions des invités dans son propre entrepôt de données, afin que les inscriptions WiFi se situent en parallèle avec les réservations et dépensent dans la même suite de rapports.
An in-house CRM calls /guests every hour with a date filter, so new opted-in diners appear in the marketing team tooling without anyone exporting a spreadsheet.
Une agence marketing reçoit sa propre clé en lecture seule par client, crée un tableau de bord en direct et d’inscription depuis /stats, et le lieu peut révoquer cette clé unique à la fin de l’engagement.
Questions fréquemment posées
Quels plans incluent l’API CaptiFi ?
L’API peut-elle changer quelque chose dans mon compte ?
Combien de clés puis-je avoir, et si j’en perds une ?
Dois-je utiliser l’API ou des webhooks ?
Puis-je lire mon programme de récompenses via l’API ?
Où se trouve la référence du point de terminaison ?
Commencez dès aujourd’hui à utiliser l’API REST de CaptiFi avec CaptiFi
30-Jour d’essai gratuit. Annulez à tout moment.
Google, Gmail, Mailchimp, Klaviyo, HubSpot, Salesforce, Facebook, Meta Pixel, Slack, Zapier, Twilio, Tripadvisor, Yelp, Trustpilot, Untappd, Feefo, REVIEWS.io, Yotpo, Square, SumUp, Airship, Revinate, Leat, Pepper, EmailOctopus, MailerLite et Incentivio sont des marques de leurs propriétaires respectifs et apparaissent ici uniquement pour identifier les services auxquels CaptiFi est connecté. CaptiFi est indépendant de ces entreprises et n’est ni sponsorisé, ni certifié ni approuvé par elles. Une intégration à venir bientôt figure sur notre feuille de route et n’est pas encore disponible. Twilio et tous les logos associés sont des marques déposées de Twilio Inc. ou de ses affiliés. Salesforce est une marque déposée de Salesforce, Inc. Slack est une marque déposée et une marque de service de Slack Technologies, Inc., enregistrée aux États-Unis et dans d’autres pays.
CaptiFi est une plateforme de marketing WiFi invité et de portail captif pour restaurants, bars, pubs, cafés, hôtels, salles de sport, salons, commerces de détail et locations de courte durée, construite par CaptiFi Ltd au Royaume-Uni et vendue à GBP, USD, EUR, CAD, et AUD NZD à des lieux du monde entier.