VitrinaAPI
Autenticación y API keys

Scopes

Todos los scopes que puede llevar una credencial: qué abre cada uno, qué roles lo traen y cuáles son sensibles o solo del dueño.

Esta página se genera desde src/services/scope-catalog.ts —el catálogo que el backend consulta en cada llamada— y desde la tabla de rutas que gasta esos permisos. No puede nombrar un scope que no existe, y la columna «Qué abre» se vuelve a contar en cada build: es el número de operaciones que hoy lo exigen, no una cifra escrita a mano.

El capítulo que explica cómo se emite, se lee y se revoca una credencial está en Autenticación y API keys.

Qué es un scope

Un permiso con la forma recurso:acción. Lo que va antes de los dos puntos es el recurso; lo que va después, qué se puede hacer con él. Una credencial lleva los suyos en una lista y no tiene ninguno más.

  • Una operación puede aceptar varios scopes, y le basta uno. El middleware que la protege recibe varios y los evalúa como un O: si la credencial lleva cualquiera de ellos, pasa. Por eso una misma operación aparece contada en más de una fila.
  • Nadie reparte lo que no tiene. Al emitir una credencial, la plataforma rechaza todo scope que no lleve quien la está emitiendo. Una API key nunca sale más ancha que la persona o la credencial que la creó.
  • * existe y no es para ti. Es el comodín de las credenciales de arranque de la plataforma. Ningún rol lo lleva, y el formulario de emisión no lo acepta.
  • El scope no es toda la puerta. Dice qué familia de operaciones se puede llamar, no qué registros se pueden ver: encima siguen aplicando la visibilidad por registro y, cuando corresponde, la del inventario publicado. Un scope abre la ruta; no decide qué devuelve.
  • Un scope sin ruta no es un scope muerto. Unos pocos protegen un campo dentro de otra respuesta, una herramienta del servidor MCP o un trabajo en segundo plano, y alguno está reservado para una operación que todavía no existe. La tabla lo dice en vez de esconderlos.

Cómo se lee una fila

  • Scope — la cadena exacta que va en scopes al emitir la credencial. La tabla va ordenada por esa cadena, así que los scopes de un mismo recurso quedan juntos.
  • Qué abre — cuántas operaciones de la API lo exigen hoy, seguidas de las áreas del contrato a las que llegan. Cuando el área es uno de los capítulos que publica este sitio, va enlazada; si no, va el nombre de la etiqueta tal como aparece en el contrato. Al final va el tier de esas operaciones: estable cambia solo con aviso de obsolescencia, beta puede cambiar con una entrada de changelog, interna no es parte de la API pública y puede cambiar sin aviso.
  • Roles — cuáles de los cuatro roles integrados lo llevan. Un rol personalizado se arma con cualquier scope de administrador, nunca con uno de dueño.
  • Marcas — solo dueño cuando ningún administrador lo lleva; sensible cuando alguna de sus operaciones toca datos personales o de salud que exceden los de contacto habituales; preset de conector cuando lo incluye la conexión guiada de una aplicación conectada; pk_ cuando lo lleva una llave publicable de navegador.

Todos los scopes

Son 182 scopes: los que reparten los roles integrados, más los del preset de conector y los de las llaves publicables. Las grafías en desuso están al final de la página.

ScopeQué abreRolesMarcas
ads:read20 operaciones · Publicidad · tier: betaDueño · Admin—
ads:write10 operaciones · Publicidad · tier: betaDueño · Admin—
ai_agents:read47 operaciones · Agentes de IA, Onboarding, Templates · tier: beta y internaDueño · Admin—
ai_agents:simulate25 operaciones · Agentes de IA, Conversation Coach, Mejoras, +1 más · tier: internaDueño · Admin—
ai_agents:write71 operaciones · Agentes de IA, Onboarding, Conversation Coach, +1 más · tier: beta y internaDueño · Admin—
analytics:read37 operaciones · Analytics, Dealer Alerts, Insights · tier: beta y internaDueño · Admin · Supervisor · Agentepreset de conector
analytics:write5 operaciones · Analytics · tier: internaDueño · Admin—
api_keys:read2 operaciones · API keys, OAuth · tier: beta y internaDueño · Admin—
api_keys:write6 operaciones · API keys, PublishableKeys, OAuth · tier: beta y internaDueño · Admin—
appointment_types:read3 operaciones · Agenda y citas, Deposit Policies · tier: beta y internaDueño · Admin · Supervisor · Agentepreset de conector
appointment_types:write6 operaciones · Agenda y citas, Deposit Policies · tier: beta y internaDueño · Admin—
appointments:delete1 operación · Agenda y citas · tier: betaDueño · Admin · Supervisor · Agente—
appointments:intake4 operaciones · Widget · tier: internaDueño · Adminpk_
appointments:read8 operaciones · Agenda y citas, Calendar overlays · tier: beta y internaDueño · Admin · Supervisor · Agentepreset de conector
appointments:write5 operaciones · Calendar overlays, Agenda y citas · tier: beta y internaDueño · Admin · Supervisor · Agente—
audit:read1 operación · Audit · tier: internaDueño · Admin—
bank_movements:read3 operaciones · Bank Movements · tier: internaDueño · Admin—
bank_movements:write3 operaciones · Bank Movements · tier: internaDueño · Admin—
billing:read10 operaciones · Método de pago · tier: beta y internaDueño · Admin—
billing:write8 operaciones · Método de pago · tier: beta y internaDueñosolo dueño
campaigns:read17 operaciones · Audiences, Campaigns, Flows de WhatsApp, +3 más · tier: beta y internaDueño · Admin · Supervisor · Agente—
campaigns:write38 operaciones · Plantillas de WhatsApp, Campaigns, Flows de WhatsApp, +3 más · tier: beta y internaDueño · Admin—
clinic:read73 operaciones · Clinic, Registro de pacientes, Precios de la clínica, +7 más · tier: beta y internaDueño · Admin · Supervisor · Agentesensible · preset de conector
clinic:write56 operaciones · Clinic, Registro de pacientes, Prestaciones de la clínica, +3 más · tier: beta y internaDueño · Adminsensible
clinic_admin:write53 operaciones · Clinic, Plantillas y conservación, Precios de la clínica, +4 más · tier: beta y internaDueño · Adminsensible
clinic_insights:read12 operaciones · Clinic, Clinic caja · tier: internaDueño · Admin—
clinic_money:read48 operaciones · Clinic caja, Presupuestos de la clínica, Clinic, +3 más · tier: beta y internaDueño · Admin—
clinic_money:write66 operaciones · Clinic caja, Presupuestos de la clínica, Feed bancario de la clínica, +3 más · tier: beta y internaDueño · Admin—
clinic_patients:read8 operaciones · Registro de pacientes · tier: betaDueño · Adminsensible
clinic_patients:write10 operaciones · Registro de pacientes · tier: beta y internaDueño · Adminsensible
clinic_record:read27 operaciones · Ficha clínica, Consentimientos, Documentos de la ficha · tier: betaDueño · Adminsensible
clinic_record:write30 operaciones · Ficha clínica, Consentimientos, Documentos de la ficha · tier: betaDueño · Adminsensible
companies:read2 operaciones · Empresas · tier: betaDueño · Admin · Supervisor · Agente—
companies:write3 operaciones · Empresas · tier: betaDueño · Admin · Supervisor · Agente—
consignments:read14 operaciones · Consignaciones · tier: beta y internaDueño · Admin—
consignments:write9 operaciones · Consignaciones, Vehículos · tier: beta y internaDueño · Admin—
contacts:read18 operaciones · Contactos, Contact Completeness · tier: beta y internaDueño · Admin · Supervisor · Agentepreset de conector
contacts:write21 operaciones · Contactos · tier: betaDueño · Admin · Supervisor · Agente—
conversations:read28 operaciones · Conversaciones, Copilot, Atributos personalizados, +3 más · tier: beta y internaDueño · Admin · Supervisor · Agentepreset de conector
conversations:write36 operaciones · Conversaciones, Mejoras · tier: beta y internaDueño · Admin · Supervisor · Agente—
copilot:read9 operaciones · Copilot · tier: internaDueño · Admin · Supervisor · Agente—
copilot:write15 operaciones · Copilot · tier: internaDueño · Admin · Supervisor · Agente—
corrections:read19 operaciones · Conversation Coach, Mejoras, Agentes de IA · tier: beta y internaDueño · Admin · Supervisor · Agente—
corrections:write10 operaciones · Conversation Coach, Mejoras · tier: internaDueño · Admin · Supervisor · Agente—
credit_applications:read5 operaciones · Solicitudes de crédito, Financial Institutions · tier: beta y internaDueño · Admin—
credit_applications:write5 operaciones · Solicitudes de crédito · tier: betaDueño · Admin—
custom_attributes:read3 operaciones · Atributos personalizados · tier: betaDueño · Admin · Supervisor · Agente—
custom_attributes:write4 operaciones · Atributos personalizados · tier: betaDueño · Admin—
dealer_sites:read1 operación · Dealer sites · tier: internaDueño · Admin—
dealer_sites:write1 operación · Dealer sites · tier: internaDueño · Admin—
dealership_economics:read25 operaciones · Insights, Overhead, Margin, +9 más · tier: internaDueño · Admin—
dealership_economics:write18 operaciones · Overhead, Cost Categories, Financial Institutions, +4 más · tier: internaDueño · Admin—
document_payments:read1 operación · Pagos de documentos · tier: betaDueño · Admin—
document_payments:write1 operación · Pagos de documentos · tier: betaDueño · Admin—
document_templates:read5 operaciones · Document Templates · tier: internaDueño · Admin—
document_templates:write5 operaciones · Document Templates · tier: internaDueño · Admin—
erp_copilot:use5 operaciones · ERP Copilot · tier: internaDueño · Admin · Supervisor · Agente—
followups:manage3 operaciones · Follow-ups · tier: internaDueño · Admin—
followups:read20 operaciones · Follow-ups, Vehículos · tier: beta y internaDueño · Admin · Supervisor · Agentepreset de conector
followups:write22 operaciones · Follow-ups · tier: internaDueño · Admin · Supervisor · Agente—
functions:read5 operaciones · Functions, Herramientas personalizadas · tier: beta y internaDueño · Admin—
functions:write9 operaciones · Herramientas personalizadas, Functions · tier: beta y internaDueño · Admin—
healthatom:read17 operaciones · HealthAtom · tier: internaDueño · Admin—
healthatom:write10 operaciones · HealthAtom, Clinic caja · tier: internaDueño · Admin—
help_centers:read11 operaciones · Centros de ayuda · tier: betaDueño · Admin · Supervisor · Agentepreset de conector
help_centers:write29 operaciones · Centros de ayuda · tier: betaDueño · Admin—
integrations:read4 operaciones · Integraciones · Meta Ads · tier: beta y internaDueño · Admin—
integrations:write7 operaciones · Integraciones · Meta Ads · tier: beta y internaDueño · Admin—
kb:read10 operaciones · Base de conocimiento — fuentes y texto indexado, Base de conocimiento — archivos, Agentes de IA · tier: betaDueño · Admin · Supervisor · Agente—
kb:write21 operaciones · Base de conocimiento — fuentes y texto indexado, Base de conocimiento — archivos, Agentes de IA · tier: betaDueño · Admin—
labels:read3 operaciones · Labels · tier: internaDueño · Admin · Supervisor · Agente—
labels:write5 operaciones · Labels · tier: internaDueño · Admin · Supervisor · Agente—
leads:intake2 operaciones · Stock público · tier: betaDueño · Adminpk_
leads:read10 operaciones · Leads · tier: betaDueño · Admin · Supervisor · Agentepreset de conector
leads:write18 operaciones · Leads, Copilot · tier: beta y internaDueño · Admin · Supervisor · Agente—
legal:read2 operaciones · Legal · tier: internaDueño · Admin—
legal:write2 operaciones · Clinic caja, Legal · tier: internaDueñosolo dueño
macros:read5 operaciones · Macros · tier: beta y internaDueño · Admin · Supervisor · Agente—
macros:write3 operaciones · Macros · tier: betaDueño · Admin—
marketplace:read46 operaciones · Vehículos, Marketplaces, Instagram Media, +3 más · tier: beta y internaDueño · Admin · Supervisor · Agentepreset de conector
marketplace:write43 operaciones · Marketplaces, Vehículos, Instagram Media, +2 más · tier: beta y internaDueño · Admin—
mcp:connectorNinguna ruta de la API lo exige hoy—preset de conector
mcp_servers:read2 operaciones · McpServers · tier: internaDueño · Admin—
mcp_servers:write3 operaciones · McpServers · tier: internaDueño · Admin—
memberships:read3 operaciones · Equipo · tier: betaDueño · Admin · Supervisor—
memberships:write6 operaciones · Equipo · tier: betaDueño · Admin—
messages:readNinguna ruta de la API lo exige hoyDueño · Admin · Supervisor · Agente—
messages:send8 operaciones · Conversaciones, Agenda y citas · tier: betaDueño · Admin · Supervisor · Agente—
messages:write1 operación · Messages · tier: internaDueño · Admin—
messaging_accounts:read19 operaciones · MessagingAccounts, Canales, Messaging Accounts, +3 más · tier: beta y internaDueño · Admin—
messaging_accounts:write30 operaciones · MessagingAccounts, Messaging Accounts, Onboarding, +3 más · tier: beta y internaDueño · Admin—
organization_legal:read2 operaciones · Organization Legal · tier: internaDueño · Admin—
organization_legal:write3 operaciones · Organization Legal · tier: internaDueño · Admin—
outbound_approvals:read2 operaciones · Outbound approvals · tier: internaDueño · Admin—
outbound_approvals:write2 operaciones · Outbound approvals · tier: internaDueño · Admin—
outbound_holds:read3 operaciones · Safety holds · tier: internaDueño · Admin—
outbound_holds:write3 operaciones · Safety holds · tier: internaDueño · Admin—
payments:read7 operaciones · Cobros y pagos, Contactos · tier: betaDueño · Admin—
payments:reverse2 operaciones · Cobros y pagos · tier: betaDueño · Admin—
payments:write13 operaciones · Cobros y pagos, Presupuestos de la clínica, Contactos · tier: betaDueño · Admin—
personal_tokens:read1 operación · Tokens personales · tier: betaDueño · Admin · Supervisor · Agente—
personal_tokens:write2 operaciones · Tokens personales · tier: betaDueño · Admin · Supervisor · Agente—
pipelines:read6 operaciones · Embudos · tier: beta y internaDueño · Admin · Supervisor · Agentepreset de conector
pipelines:write6 operaciones · Embudos · tier: beta y internaDueño · Admin—
price_approval:approve1 operación · Aprobaciones de precio · tier: betaDueño · Admin—
price_approval:read2 operaciones · Aprobaciones de precio · tier: betaDueño · Adminpreset de conector
price_approval:request1 operación · Aprobaciones de precio · tier: betaDueño · Admin—
pricing:read11 operaciones · Pricing · tier: internaDueño · Admin—
pricing:write6 operaciones · Pricing · tier: internaDueño · Admin—
provisioning:read3 operaciones · Provisioning · tier: internaDueño · Admin—
provisioning:write7 operaciones · Provisioning · tier: internaDueño · Admin—
purchase_notes:read2 operaciones · Notas de compra · tier: betaDueño · Admin—
purchase_notes:void1 operación · Notas de compra · tier: betaDueño · Admin—
purchase_notes:write2 operaciones · Notas de compra · tier: betaDueño · Admin—
quotes:read2 operaciones · Cotizaciones · tier: betaDueño · Admin—
quotes:void1 operación · Cotizaciones · tier: betaDueño · Admin—
quotes:write3 operaciones · Cotizaciones · tier: betaDueño · Admin—
reservations:dispose_abono1 operación · Reservas · tier: betaDueño · Admin—
reservations:read2 operaciones · Reservas · tier: betaDueño · Admin—
reservations:void1 operación · Reservas · tier: betaDueño · Admin—
reservations:write1 operación · Reservas · tier: betaDueño · Admin—
reservo:read2 operaciones · Reservo · tier: internaDueño · Admin—
reservo:write5 operaciones · Reservo · tier: internaDueño · Admin—
rexplus:read2 operaciones · fuera del contrato publicadoDueño · Admin—
rexplus:write4 operaciones · fuera del contrato publicadoDueño · Admin—
roles:read2 operaciones · Roles personalizados · tier: betaDueño · Admin—
roles:write3 operaciones · Roles personalizados · tier: betaDueño · Admin—
routing:read3 operaciones · Reglas de asignación · tier: betaDueño · Admin—
routing:write5 operaciones · Reglas de asignación · tier: betaDueño · Admin—
sale_notes:read10 operaciones · Notas de venta, Transfer Tax · tier: beta y internaDueño · Admin—
sale_notes:void1 operación · Notas de venta · tier: betaDueño · Admin—
sale_notes:write9 operaciones · Notas de venta, Reservas · tier: beta y internaDueño · Admin—
sales_leaderboard:read1 operación · Insights · tier: internaDueño · Admin—
sandbox:read3 operaciones · Espacio de prueba · tier: betaDueño · Admin—
sandbox:write3 operaciones · Espacio de prueba · tier: betaDueño · Admin—
schedule_config:write1 operación · Agenda y citas · tier: betaDueño · Admin—
seller_compensation:read2 operaciones · Notas de venta, Seller Compensation · tier: internaDueño · Admin—
seller_compensation:write2 operaciones · Notas de venta, Seller Compensation · tier: internaDueño · Admin—
service_lifecycle:read6 operaciones · Service lifecycle · tier: internaDueño · Admin—
service_lifecycle:write11 operaciones · Service lifecycle · tier: internaDueño · Admin—
slas:read2 operaciones · SLAs · tier: betaDueño · Admin · Supervisor · Agente—
slas:write3 operaciones · SLAs · tier: betaDueño · Admin—
stages:read2 operaciones · Etapas · tier: betaDueño · Admin · Supervisor · Agente—
stages:write5 operaciones · Etapas · tier: betaDueño · Admin—
stock:read5 operaciones · Stock público · tier: betaDueño · Adminpk_
stock_dedup:read1 operación · Vehículos · tier: betaDueño · Admin—
stock_dedup:write1 operación · Vehículos · tier: betaDueño · Admin—
stock_photo_mirror:read1 operación · Vehículos · tier: betaDueño · Admin—
stock_photo_mirror:write2 operaciones · Vehículos · tier: betaDueño · Admin—
stock_retirement:read1 operación · Vehículos · tier: betaDueño · Admin—
stock_retirement:write1 operación · Vehículos · tier: betaDueño · Admin—
storefront_events:write2 operaciones · Stock público · tier: betaDueño · Adminpk_
tags:read4 operaciones · Etiquetas, Conversaciones · tier: betaDueño · Admin · Supervisor · Agente—
tags:write5 operaciones · Etiquetas, Conversaciones · tier: betaDueño · Admin · Supervisor · Agente—
teams:read3 operaciones · Equipos de trabajo · tier: betaDueño · Admin · Supervisor · Agentepreset de conector
teams:write6 operaciones · Equipos de trabajo · tier: betaDueño · Admin · Supervisor—
tenant:deleteNinguna ruta de la API lo exige hoyDueñosolo dueño
tenant:read9 operaciones · Ajustes del workspace, Sucursales, Digest, +1 más · tier: beta y internaDueño · Admin · Supervisor · Agentepreset de conector
tenant:write19 operaciones · Ajustes del workspace, Sucursales, Complementos, +2 más · tier: beta y internaDueño · Admin—
tenant_bank_accounts:read2 operaciones · Bank Accounts · tier: internaDueño · Admin—
tenant_bank_accounts:write2 operaciones · Bank Accounts · tier: internaDueño · Admin—
tickets:claim1 operación · Tickets · tier: betaDueño · Admin · Supervisor · Agente—
tickets:read6 operaciones · Tickets · tier: betaDueño · Admin · Supervisor · Agentepreset de conector
tickets:write7 operaciones · Tickets, Conversaciones, Copilot · tier: beta y internaDueño · Admin · Supervisor · Agente—
tool_credentials:read2 operaciones · Credenciales de herramientas · tier: betaDueño · Admin—
tool_credentials:write3 operaciones · Credenciales de herramientas · tier: betaDueño · Admin—
tool_invocations:read2 operaciones · fuera del contrato publicadoDueño · Admin—
tools:read2 operaciones · Tools · tier: internaDueño · Admin · Supervisor · Agente—
transfer_cases:read3 operaciones · Transfer Cases · tier: internaDueño · Admin—
transfer_cases:write5 operaciones · Transfer Cases · tier: internaDueño · Admin—
triggers:read2 operaciones · Triggers · tier: betaDueño · Admin—
triggers:write3 operaciones · Triggers · tier: betaDueño · Admin—
vehicle_pipeline:read1 operación · Vehículos · tier: betaDueño · Admin · Supervisor · Agentepreset de conector
vehicle_pipeline:write4 operaciones · Vehículos · tier: betaDueño · Admin · Supervisor · Agente—
vehicle_registry:read2 operaciones · Adjuntos de vehículo · tier: betaDueño · Admin—
vehicle_registry:write2 operaciones · Adjuntos de vehículo · tier: betaDueño · Admin—
voice_drift:read1 operación · fuera del contrato publicadoDueño · Admin—
webhooks:read4 operaciones · Webhooks · tier: betaDueño · Admin—
webhooks:write5 operaciones · Webhooks · tier: betaDueño · Admin—
widget:chat4 operaciones · Widget · tier: interna—pk_
worker_failures:read2 operaciones · WorkerFailures · tier: internaDueño · Admin—
worker_failures:write2 operaciones · WorkerFailures · tier: internaDueño · Admin—

El preset de conector

Lo que emite la conexión guiada de una aplicación conectada: un permiso de lectura por cada familia de herramientas que expone el perfil del conector, y nada más. No es un rol, y ninguna persona lo lleva.

Dentro va mcp:connector, que no es un permiso: no protege ninguna ruta, ninguna herramienta, ningún campo ni ninguna columna. Su único efecto es quitarle capacidad a quien lo lleva —el servidor MCP ve la marca y reduce su catálogo a un perfil de solo lectura—, y por eso puede viajar a la vista en la credencial: no hay nada a lo que escalar. Una credencial con esta marca y nada más puede hacer estrictamente menos que una credencial sin nada.

  • analytics:read
  • appointment_types:read
  • appointments:read
  • clinic:read
  • contacts:read
  • conversations:read
  • followups:read
  • help_centers:read
  • leads:read
  • marketplace:read
  • mcp:connector
  • pipelines:read
  • price_approval:read
  • teams:read
  • tenant:read
  • tickets:read
  • vehicle_pipeline:read

La lectura de márgenes y costos no viene incluida: se añade marcando la casilla correspondiente al conectar, y sin ese scope esas herramientas ni siquiera aparecen en el catálogo.

Las llaves publicables pk_

Una llave pk_ vive en el navegador, así que no lleva scopes propios: la plataforma le resuelve este conjunto fijo en cada petición. Ningún rol lo reparte y el formulario de emisión no lo ofrece; una pk_ no puede llevar un permiso de escritura amplio ni uno de administración.

  • appointments:intake
  • leads:intake
  • stock:read
  • storefront_events:write
  • widget:chat

Agregar una entrada a este conjunto se lo concede a todas las pk_ que ya existen, sin volver a emitirlas — por eso la lista es corta y cada entrada abre una sola superficie pública.

Grafías en desuso

Un puente de una sola versión: quien lleva la cadena antigua es tratado como si llevara la nueva, y nada más cambia. La grafía en desuso no se puede repartir, no la ofrece ningún rol y no la acepta el formulario de emisión — solo sigue funcionando en las credenciales que ya la tenían.

Grafía en desusoSe trata como
healthatom:readclinic:read
healthatom:writeclinic:write

En esta página