Alcances de una API key

Qué es

El alcance limita lo que puede hacer una API key sobre la empresa a la que pertenece. Hay dos valores:

Solo lectura (read): únicamente GET (y HEAD). Sirve para exportar o consultar catálogo, sucursales, medios de pago e informes.
Lectura y escritura (write): incluye la lectura y además puede crear, actualizar o borrar en los endpoints de esa empresa. Es el alcance para cargar un catálogo, importar un CSV, poner fotos o cambiar cobros.

Una clave de escritura no es un superadmin. No puede crear otras empresas, cambiar flags de plataforma ni tocar otra empresa.

Dónde está

El alcance se elige al crear la clave en Configuración → Equipo → API keys. Después no se edita: si necesitás otro alcance, creá una clave nueva y revocá la anterior.

Cómo se usa

Alcance	Métodos	Ejemplos
`read`	`GET`	Listar catálogo, sucursales, medios de pago, ventas.
`write`	`GET` más `POST`, `PUT`, `PATCH`, `DELETE`	Importar CSV, actualizar un producto, cambiar cobros, crear sucursales.

Si una clave read llama a un POST o PUT, la API responde 403 con insufficient_scope.

# Falla con una clave de solo lectura
curl -sS -X POST "$TERO_API/admin/tenants/$TERO_TENANT_ID/products/import/preview" \
  -H "Authorization: Bearer $TERO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"csvText":"nombre,precio_pesos\nAgua,500"}'

Configuración

Las claves no pueden crear, listar ni revocar otras API keys. Eso se hace en el back office, con una sesión de administrador o de superadmin. Tampoco alcanzan para:

crear o renombrar empresas de plataforma;
cambiar funcionalidades de plataforma;
ver la flota global de sincronización;
administrar releases de la APK.

Sí pueden, con write, operar el resto de la API de esa empresa: productos, categorías, importación CSV, imageUrl, medios de pago, sucursales, stock, empleados y lo demás que un administrador haría en el back office.

Tips y advertencias

Para un reporte o un respaldo, usá read. Reservá write para la carga inicial o una integración que realmente actualice datos.

Una clave write implica read: no hace falta crear dos claves para el mismo script si necesita consultar y después guardar.

API de administración

Integración con ERP

Qué es

Dónde está

Cómo se usa

Configuración

Tips y advertencias

Relacionado

Autenticación

Ejemplos

​Qué es

​Dónde está

​Cómo se usa

​Configuración

​Tips y advertencias

​Relacionado

Autenticación

Ejemplos

Qué es

Dónde está

Cómo se usa

Configuración

Tips y advertencias

Relacionado