# VENTRY API

> API pública de VENTRY para integradores externos

- [Introducción](https://docs.ventry.es/introduction.md): Qué puedes hacer con la API de VENTRY y cómo está organizada.
- [Autenticación](https://docs.ventry.es/authentication.md): Cómo obtener, usar y rotar una API key de VENTRY.
- [Errores](https://docs.ventry.es/errors.md): Forma de los errores, catálogo de códigos y qué hacer con cada uno.
- [Paginación](https://docs.ventry.es/pagination.md): Cursores y sincronización incremental.
- [Idempotencia](https://docs.ventry.es/idempotency.md): Cómo reintentar una escritura sin duplicar nada.
- [Límites de peticiones](https://docs.ventry.es/rate-limits.md): Cupos, cabeceras y cómo comportarse ante un 429.
- [Versionado](https://docs.ventry.es/versioning.md): Qué puede cambiar sin avisar y qué no.
- [Volcar entradas](https://docs.ventry.es/guides/import-tickets.md): Cómo llevar las entradas que vendes en tu plataforma a VENTRY.
- [Acreditar y validar accesos](https://docs.ventry.es/guides/accreditation.md): Canjear entradas por pulseras y controlar el acceso a zonas desde tu propia aplicación.
- [Cashless](https://docs.ventry.es/guides/cashless.md): Saldos, consumiciones, recargas y conciliación.
- [Webhooks (próximamente)](https://docs.ventry.es/webhooks-roadmap.md): Qué hay previsto y cómo resolverlo mientras tanto.
- [Comprobar la API key](https://docs.ventry.es/api-reference/meta/comprobar-la-api-key.md): Devuelve los permisos y el ámbito de la clave con la que se llama. Útil para validar la configuración de un integrador.
- [Datos del evento](https://docs.ventry.es/api-reference/evento/datos-del-evento.md): Nombre, fechas, moneda y huso horario del evento. Conviene leerlo al arrancar la integración: la moneda y el huso son necesarios para interpretar el resto de respuestas.
- [Días del evento](https://docs.ventry.es/api-reference/evento/días-del-evento.md): Jornadas del evento. Sus identificadores son los que se usan al crear entradas (`valid_days`) y al filtrar ventas.
- [Tipos de entrada](https://docs.ventry.es/api-reference/evento/tipos-de-entrada.md): Tipos de entrada del evento con las zonas a las que dan acceso y las consumiciones incluidas. Si la API key está limitada a ciertos tipos, sólo aparecen ésos.
- [Zonas del recinto](https://docs.ventry.es/api-reference/evento/zonas-del-recinto.md): Zonas en las que se divide el recinto. Sus identificadores se usan al validar el acceso de una pulsera.
- [Listar entradas](https://docs.ventry.es/api-reference/entradas/listar-entradas.md): Devuelve las entradas del evento dentro del ámbito de la API key.
- [Crear entradas](https://docs.ventry.es/api-reference/entradas/crear-entradas.md): Da de alta una o varias entradas (máximo 500 por llamada).
- [Consultar una entrada](https://docs.ventry.es/api-reference/entradas/consultar-una-entrada.md): Estado actual de una entrada por su código. `checked_in_at` indica cuándo se acreditó y `wristband` la pulsera vinculada.
- [Anular una entrada](https://docs.ventry.es/api-reference/entradas/anular-una-entrada.md): Marca la entrada como `inactive`, de modo que ya no sirve para acreditarse.
- [Listar escaneos de acreditación](https://docs.ventry.es/api-reference/accesos/listar-escaneos-de-acreditación.md): Registro de escaneos en las puertas, tanto aceptados como denegados. Ordenado del más antiguo al más reciente para poder recorrerlo de forma incremental con `since` y el cursor.
- [Acreditar una entrada](https://docs.ventry.es/api-reference/accesos/acreditar-una-entrada.md): Canjea la entrada y le vincula la pulsera escaneada. Es la operación de puerta: el operario lee el QR y después la pulsera.
- [Validar el acceso de una pulsera a una zona](https://docs.ventry.es/api-reference/accesos/validar-el-acceso-de-una-pulsera-a-una-zona.md): Comprueba si una pulsera puede entrar en una zona concreta y deja constancia del escaneo.
- [Consultar una pulsera](https://docs.ventry.es/api-reference/cashless/consultar-una-pulsera.md): Saldo y estado de una pulsera a partir de su código NFC o UHF, junto con la entrada de la que salió.
- [Consumiciones de una pulsera](https://docs.ventry.es/api-reference/cashless/consumiciones-de-una-pulsera.md): Ventas cobradas contra el saldo de una pulsera concreta.
- [Listar consumiciones](https://docs.ventry.es/api-reference/cashless/listar-consumiciones.md): Todas las ventas del evento. Pensado para volcar a un almacén de datos: recorre con el cursor y usa `since` sobre `occurred_at` para las pasadas incrementales.
- [Listar recargas y retiradas](https://docs.ventry.es/api-reference/cashless/listar-recargas-y-retiradas.md): Movimientos de saldo de las pulseras. `direction: topup` añade saldo y `withdraw` lo devuelve.
- [Recargar el saldo de una pulsera](https://docs.ventry.es/api-reference/cashless/recargar-el-saldo-de-una-pulsera.md): Añade saldo a una pulsera. Pensado para integradores que cobran la recarga en su propia plataforma (una aplicación de recarga online, por ejemplo) y necesitan reflejarla en VENTRY.
- [Resumen de ventas](https://docs.ventry.es/api-reference/informes/resumen-de-ventas.md): Agregado de ventas, recargas y retiradas. Sin `day` devuelve el acumulado de todo el evento. Los importes coinciden con el cierre de caja del panel de VENTRY.

## OpenAPI Specs

- [openapi](/openapi.json)