Saltar al contenido principal

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​

ÁmbitoQué permite
bookings:readVer reservas, buscar reservas, consultar los detalles de las reservas
bookings:writeCrear nuevas reservas, actualizar reservas existentes, cancelar reservas

Productos​

ÁmbitoQué permite
products:readVer productos, niveles de inventario e información de precios
products:writeCrear y actualizar productos, gestionar unidades de inventario

Experiencias​

ÁmbitoQué permite
experiences:readVer experiencias, horarios y disponibilidad
experiences:writeCrear y actualizar experiencias, gestionar horarios

Tienda​

ÁmbitoQué permite
store:readVer productos de la tienda, categorías y niveles de inventario
store:writeCrear y actualizar productos y categorías de la tienda, ajustar el inventario

Clientes​

ÁmbitoQué permite
customers:readVer perfiles de clientes, historial de reservas y datos de contacto
customers:writeCrear y actualizar registros de clientes

Personal​

ÁmbitoQué permite
staff:readVer miembros del personal, roles y horarios
staff:writeGestionar registros y asignaciones del personal

Exenciones de responsabilidad y formularios​

ÁmbitoQué permite
waivers:readVer exenciones de responsabilidad, formularios y respuestas enviadas
waivers:writeGestionar exenciones de responsabilidad y formularios

Encuestas​

ÁmbitoQué permite
surveys:readVer encuestas y respuestas
surveys:writeGestionar encuestas

Promociones​

ÁmbitoQué permite
promotions:readVer códigos promocionales, vales y su uso
promotions:writeCrear y gestionar códigos promocionales y vales

Informes​

ÁmbitoQué permite
reports:readAcceder a los datos de informes de ingresos, reservas, inventario y clientes

Configuración​

ÁmbitoQué permite
settings:readVer la configuración del negocio, ubicaciones y ajustes
settings:writeActualizar la configuración del negocio

Webhooks​

ÁmbitoQué permite
webhooks:readVer configuraciones de webhooks y registros de entrega
webhooks:writeCrear, actualizar y eliminar webhooks

Lista de espera​

ÁmbitoQué permite
waitlist:readVer las entradas de la lista de espera y su estado
waitlist:writeGestionar las entradas de la lista de espera

MCP (agentes de IA)​

ÁmbitoQué permite
mcp:accessConectarse 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 disponibilidadproducts:read, experiences:read, store:read
Formulario de reserva en líneabookings:read, bookings:write, customers:read, customers:write
Sincronización contable (solo lectura)bookings:read, reports:read
Aplicación móvil completaTodos los ámbitos de lectura y escritura
Panel de análisisbookings:read, customers:read, reports:read
Exportación de datos de clientescustomers:read
Creación automática de reservasbookings: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.

La página de configuración de API e integraciones que muestra las claves de API y los ámbitos


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.