Which plans include the CaptiFi API?

The API is included on the Growth plan and above, at no extra cost, alongside webhooks. A 30-day free trial started on Growth or Pro includes it, so you can build against it during the trial. On Essentials the API Keys page still explains what the API does and how to upgrade.

Can the API change anything in my account?

No. The customer API is read-only. Keys can read venues, guests and statistics, and cannot modify your splash pages, settings or guest records, which is why it is safe to hand a key to a developer or an agency.

How many keys can I have, and what if I lose one?

You can hold up to five keys at once, and using a separate key per system means you can revoke one without breaking the others. Keys are stored hashed and shown only once at creation, so if you lose one, revoke it and create a replacement.

Should I use the API or webhooks?

Use webhooks when you want to react to a guest as they arrive and your system can accept an inbound HTTPS request. Use the API when you want to pull a list on your own schedule, or when your system can only make outbound requests. Plenty of setups use both: webhooks for live events, the API to backfill history.

Where is the endpoint reference?

The full reference, including authentication, filters, pagination and example responses, is in the CaptiFi documentation at docs.captifi.io under Dashboard, API.

Integración con desarrolladores

CaptiFi REST API + CaptiFi

Descarga tus locales, inscripciones de invitados y estadísticas de visitas a cualquier sistema con una API REST de solo lectura y claves de autoservicio. Incluido en Growth y superiores. Prueba gratuita.

Comienza la prueba gratuita Ver todas las integraciones

Resumen

¿Qué hace la integración de la 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.

La API REST de CaptiFi existe para los sistemas que ningún directorio puede cubrir: una plataforma de reservas a medida, un CRM interno, un almacén de datos, una hoja de cálculo de informes en la que ya vive un equipo financiero. En lugar de pedirte que exportes un CSV cada semana, CaptiFi te ofrece una API JSON de solo lectura sobre los mismos datos de invitados que muestra tu panel, con claves de autoservicio que tú mismo creas y revocas.

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.

La API es deliberadamente de solo lectura. Nada de lo que una clave pueda hacer cambiará tus páginas de inicio, tus ajustes o tus registros de invitados, lo que hace que sea seguro entregarla a un desarrollador o a una agencia sin entregar tu panel de control. Las claves se almacenan hasheadas como contraseñas y se revelan exactamente una vez, puedes contener hasta cinco a la vez, y revocar una nunca afecta a las demás. Combina la API con webhooks: webhooks para eventos en vivo cuando llegan invitados, la API para rellenar el historial y crear informes.

Las cuentas en Growth y superiores también pueden leer su programa de recompensas con las mismas claves: el programa y sus sedes, miembros, el libro de puntos de cada miembro, recompensas emitidas, canjeos y ofertas, todo bajo /api/v1/customer/rewards. Los resultados llegan primero con la paginación habitual y pueden reducirse por correo electrónico o teléfono del socio, nivel, estado, oferta, lugar o una ventana horaria. Esos endpoints también son de solo lectura y siguen el cambio y plan de recompensas de la cuenta. Las cajas y quioscos usan una clave de terminal separada contra /api/v1/rewards-pos para comprobar un código de recompensa con la factura, canjearlo una vez con una referencia para el recibo, revertir esa venta en 30 minutos, buscar a un miembro o puntos de recompensa por una venta. Cada canjeo lleva una Clave de Idempotencia, así que una caja que intenta de nuevo tras una conexión caída recibe la misma respuesta en lugar de un segundo canje.

Lo que obtienes

¿Por qué conectar la API REST de CaptiFi con CaptiFi?

Tus datos de invitados en tus propios sistemas

Reúne los locales, inscripciones de invitados y estadísticas de visitas directamente en una plataforma de reservas, CRM, almacén o herramienta de informes, sin exportar CSV semanal y sin esperar a que se construya un conector nativo.

Solo lectura por diseño

Una clave puede leer tus datos y nada más. No puede editar páginas de inicio, cambiar ajustes ni tocar los registros de invitados, por lo que entregar una a un desarrollador o agencia no conlleva ningún riesgo de compartir un inicio de sesión en el panel.

Llaves de autoservicio, revocables una por una

Crea hasta cinco claves tú mismo, una por sistema, para poder retirar o rotar una sola integración sin romper el resto. Las claves se almacenan hashadas y se muestran una vez, exactamente como una contraseña.

Una forma de respuesta predecible

Cada endpoint devuelve filas bajo datos y paginación o totales bajo meta, así que el cliente que escribes para los invitados funciona igual en los locales y estadísticas.

Qué datos fluyen hacia la API REST de CaptiFi

Tus locales y sus identificadores

Inscripciones de invitados: nombre, correo electrónico, teléfono donde se hayan capturado

Estado de consentimiento de marketing y contacto por huésped

Fechas de primera y más reciente visita, recuentos de visitas

Visita y opta por el total de cualquier periodo que solicites

La cuenta y el plan a los que pertenece una clave

Cómo funciona

En marcha en minutos

Crear una clave API

Abre las Claves API en tu panel de CaptiFi y ponle a la clave un nombre que coincida con el sistema que la va a utilizar. La clave aparece una vez, inmediatamente después de crearla, así que cópiala inmediatamente: se almacena con hash y no puede volver a mostrarse.

Autentica tus solicitudes

Envía la clave como un encabezado Authorization: Bearer, con Accept: application/json, junto a la URL base https://app.captifi.io/api/v1/customer.

Llama a los endpoints que necesitas

Usa /venues para tus sitios, /guests para inscripciones con filtros y paginación, /stats para totales de visitas y opt-in, y /me para confirmar la cuenta. Las respuestas siempre llevan filas bajo datos y paginación bajo meta.

Añadir webhooks para eventos en directo

Usa la API para extraer el historial y crear informes según tu propio calendario, y añade un endpoint webhook para que las nuevas inscripciones te lleguen en cuanto ocurran, en lugar de en tu siguiente encuesta.

Lee la guía de configuración de la API REST de CaptiFi

Paso a paso, con capturas de pantalla.

En el mundo real

Cómo los locales utilizan la API REST de CaptiFi con CaptiFi

Grupo hotelero

Un grupo recopila cada noche los registros de invitados en su propio almacén de datos, de modo que los opt-ins por WiFi se sitúan junto a las reservas y gasten en la misma sala de informes.

Cadena de restaurantes

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.

Agencia

A una agencia de marketing se le asigna su propia clave de solo lectura por cliente, crea un panel de seguimiento en vivo y de opt-in desde /stats, y el local puede revocar esa única clave al final del contacto.

Preguntas frecuentes

¿Qué planes incluyen la API de CaptiFi?

La API está incluida en el plan Growth y superiores, sin coste adicional, junto con los webhooks. Una 30prueba gratuita de un día iniciada en Growth o Pro la incluye, para que puedas construir contra ella durante la prueba. En Essentials, la página de Claves API sigue explicando qué hace la API y cómo actualizar.

¿Puede la API cambiar algo en mi cuenta?

No. La API del cliente es de solo lectura. Las llaves pueden leer locales, invitados y estadísticas, y no pueden modificar tus páginas de inicio, ajustes ni registros de invitados, por eso es seguro entregar una llave a un desarrollador o a una agencia.

¿Cuántas llaves puedo tener y qué pasa si pierdo una?

Puedes mantener hasta cinco claves a la vez, y usar una llave separada por sistema significa que puedes revocar una sin romper las demás. Las claves se almacenan hashadas y se muestran solo una vez al crearlas, así que si pierdes una, revocala y crea una de reemplazo.

¿Debería usar la API o los webhooks?

Usa webhooks cuando quieras reaccionar a un invitado a medida que llegue y tu sistema pueda aceptar una solicitud HTTPS entrante. Usa la API cuando quieras sacar una lista a tu ritmo, o cuando tu sistema solo pueda hacer solicitudes salientes. Muchas configuraciones usan ambos: webhooks para eventos en vivo, la API para rellenar historial.

¿Puedo leer mi programa de recompensas a través de la API?

Yes, on Growth and above, with the same keys: the programme and its venues, members, each member's points ledger, issued rewards, redemptions and offers under /api/v1/customer/rewards, read-only and following your Rewards switch and plan. A till or kiosk that needs to redeem uses a separate terminal key against /api/v1/rewards-pos, with an Idempotency-Key on every redeem so a retry never redeems twice.

¿Dónde está la referencia del endpoint?

La referencia completa, incluyendo autenticación, filtros, paginación y respuestas de ejemplo, está en la documentación de CaptiFi en docs.captifi.io bajo Dashboard, API.

Combina bien con

Ganchos de red Zapier HubSpot

Empieza a usar la API REST de CaptiFi con CaptiFi hoy mismo

30-Prueba gratuita de un día. Cancela cuando quieras.

Comienza la prueba gratuita Explora todas las integraciones

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 e Incentivio son marcas comerciales de sus respectivos propietarios y aparecen aquí solo para identificar los servicios a los que CaptiFi se conecta. CaptiFi es independiente de estas empresas y no está patrocinada, certificada ni avalada por ellas. Una integración que se acerca está en nuestra hoja de ruta y aún no está disponible. Twilio y todos los logotipos relacionados son marcas registradas de Twilio Inc. o sus afiliados. Salesforce es una marca registrada de Salesforce, Inc. Slack es una marca y marca de servicio de Slack Technologies, Inc., registrada en EE. UU. y en otros países.