Explicación de los ámbitos de la API Growth+This feature requires the Growth+ plan or higher
Los ámbitos de la API controlan a qué puede acceder una clave de API. Al crear una clave de API, seleccione solo los ámbitos que su integración necesita. Esto sigue el principio de mínimo privilegio: cada clave debe tener el acceso mínimo necesario.
Ámbitos disponibles
Reservas
| Ámbito | Qué permite |
|---|---|
bookings:read | Ver reservas, buscar reservas, consultar los detalles de las reservas |
bookings:write | Crear nuevas reservas, actualizar reservas existentes, cancelar reservas |
Productos
| Ámbito | Qué permite |
|---|---|
products:read | Ver productos, niveles de inventario e información de precios |
products:write | Crear y actualizar productos, gestionar unidades de inventario |
Experiencias
| Ámbito | Qué permite |
|---|---|
experiences:read | Ver experiencias, horarios y disponibilidad |
experiences:write | Crear y actualizar experiencias, gestionar horarios |
Tienda
| Ámbito | Qué permite |
|---|---|
store:read | Ver productos de la tienda, categorías y niveles de inventario |
store:write | Crear y actualizar productos y categorías de la tienda, ajustar el inventario |
Clientes
| Ámbito | Qué permite |
|---|---|
customers:read | Ver perfiles de clientes, historial de reservas y datos de contacto |
customers:write | Crear y actualizar registros de clientes |
Personal
| Ámbito | Qué permite |
|---|---|
staff:read | Ver miembros del personal, roles y horarios |
staff:write | Gestionar registros y asignaciones del personal |
Exenciones de responsabilidad y formularios
| Ámbito | Qué permite |
|---|---|
waivers:read | Ver exenciones de responsabilidad, formularios y respuestas enviadas |
waivers:write | Gestionar exenciones de responsabilidad y formularios |
Encuestas
| Ámbito | Qué permite |
|---|---|
surveys:read | Ver encuestas y respuestas |
surveys:write | Gestionar encuestas |
Promociones
| Ámbito | Qué permite |
|---|---|
promotions:read | Ver códigos promocionales, vales y su uso |
promotions:write | Crear y gestionar códigos promocionales y vales |
Informes
| Ámbito | Qué permite |
|---|---|
reports:read | Acceder a los datos de informes de ingresos, reservas, inventario y clientes |
Configuración
| Ámbito | Qué permite |
|---|---|
settings:read | Ver la configuración del negocio, ubicaciones y ajustes |
settings:write | Actualizar la configuración del negocio |
Webhooks
| Ámbito | Qué permite |
|---|---|
webhooks:read | Ver configuraciones de webhooks y registros de entrega |
webhooks:write | Crear, actualizar y eliminar webhooks |
Lista de espera
| Ámbito | Qué permite |
|---|---|
waitlist:read | Ver las entradas de la lista de espera y su estado |
waitlist:write | Gestionar las entradas de la lista de espera |
MCP (agentes de IA)
| Ámbito | Qué permite |
|---|---|
mcp:access | Conectarse a EquipDash mediante el protocolo MCP para integraciones con agentes de IA |
Elegir los ámbitos adecuados
Estos son algunos escenarios de integración habituales y los ámbitos que suelen necesitar:
| Integración | Ámbitos recomendados |
|---|---|
| Sitio web que muestra disponibilidad | products:read, experiences:read, store:read |
| Formulario de reserva en línea | bookings:read, bookings:write, customers:read, customers:write |
| Sincronización contable (solo lectura) | bookings:read, reports:read |
| Aplicación móvil completa | Todos los ámbitos de lectura y escritura |
| Panel de análisis | bookings:read, customers:read, reports:read |
| Exportación de datos de clientes | customers:read |
| Creación automática de reservas | bookings:write, customers:write, products:read, experiences:read |
Categorías de ámbitos
Al crear una clave de API, los ámbitos se agrupan por categoría. Usted puede:
- Hacer clic en Seleccionar todo en una categoría para activar todos los ámbitos de ese grupo.
- Hacer clic en Deseleccionar todo en una categoría para quitar todos los ámbitos de ese grupo.
- Usar Seleccionar todo / Deseleccionar todo en el nivel superior para activar o desactivar todo a la vez.

Cosas que debe tener en cuenta
- Una clave sin el ámbito necesario recibirá una respuesta 403 Forbidden para ese endpoint.
- Puede actualizar los ámbitos de una clave existente sin necesidad de regenerar la clave en sí.
- Los ámbitos de lectura (
*:read) solo permiten ver datos. Los ámbitos de escritura (*:write) permiten crear y modificar datos, pero también incluyen el acceso de lectura para esos endpoints. - Por seguridad, evite otorgar a una clave más ámbitos de los que necesita.