Conceptos básicos
Cuentas y aislamiento
Una clave está ligada a una suscripción. La mayoría de los recursos se limitan exactamente a esa suscripción; los contactos, los proyectos, las etiquetas y los campos personalizados también son visibles desde la cuenta principal de una cuenta de facturación.
Organizaciones y cuentas
Enlace a esta sección: Organizaciones y cuentasUna empresa de Filmo puede ser una suscripción por sí sola, o una organización con varias. En una organización, una cuenta completa es la principal, y una cuenta de facturación es la que factura bajo una cuenta completa principal. La clave que creas pertenece a una de ellas, y GET /api devuelve el nombre de la cuenta que hizo la petición.
Ninguna operación cruza nunca datos entre organizaciones distintas.
Dos tipos de visibilidad
Enlace a esta sección: Dos tipos de visibilidad- Organización
- Cuenta completa (principal)Solo ve sus propios datos.
- Cuentas de facturaciónFacturan bajo la cuenta principal. También ven los recursos heredados de la cuenta principal.
Heredado de la cuenta principal
Una cuenta de facturación ve los de la cuenta principal y valida las referencias contra ese mismo conjunto
- Heredado de la cuenta principal
- Contactos
- Heredado de la cuenta principal
- Proyectos
- Heredado de la cuenta principal
- Etiquetas
- Heredado de la cuenta principal
- Campos personalizados
- Heredado de la cuenta principal
- Leer un pedido por id
Igualdad estricta de suscripción
Limitado exactamente a la suscripción dueña de la clave
- Igualdad estricta de suscripción
- Elementos
- Igualdad estricta de suscripción
- Elementos con número de serie
- Igualdad estricta de suscripción
- Espacios
- Igualdad estricta de suscripción
- Facturas
- Igualdad estricta de suscripción
- Presupuestos
- Igualdad estricta de suscripción
- Tareas
- Igualdad estricta de suscripción
- Tipos de tarea
- Igualdad estricta de suscripción
- Tickets de reparación
- Igualdad estricta de suscripción
- Vehículos
- Igualdad estricta de suscripción
- Personal
- Igualdad estricta de suscripción
- Subalquileres
- Igualdad estricta de suscripción
- Pedidos de compra
- Igualdad estricta de suscripción
- Contratos
- Igualdad estricta de suscripción
- Tipos de proyecto
- Igualdad estricta de suscripción
- La lista de pedidos
- Igualdad estricta de suscripción
- Disponibilidad
- No hay ampliación entre cuentas de facturación hermanas, ni de la cuenta principal a sus cuentas de facturación, y ninguna operación cruza datos entre organizaciones.
- Leer un recurso fuera de tu tenancy es un
404 not_found, idéntico a que no exista. Escribir un cuerpo que referencia un identificador fuera de ella es un400 validation_errorque nombra el campo, y no se escribe nada.
Hasta dónde ve una clave depende de cómo modela Filmo la propiedad de cada recurso. La tabla siguiente enumera los recursos de cada tipo.
| Semántica | Recursos | Qué ve una clave |
|---|---|---|
| Heredado de la cuenta principal | Contactos, proyectos, etiquetas y campos personalizados, y lectura de un pedido por id | Una cuenta de facturación también ve estos recursos de su cuenta principal, y valida las referencias contra ese mismo conjunto cuando escribe. Una cuenta completa, y una suscripción fuera de cualquier organización, solo ve los suyos. |
| Igualdad estricta de suscripción | Todo lo demás: artículos, unidades serializadas, espacios, facturas, presupuestos, tareas, tipos de tarea, tickets de reparación, vehículos, personal, subalquileres, órdenes de compra, contratos, tipos de proyecto, la lista de pedidos y la disponibilidad | Exactamente la suscripción a la que pertenece la clave. No se amplía a la organización. |
La herencia va en un solo sentido. No hay ampliación entre cuentas de facturación hermanas ni de una cuenta principal a sus cuentas de facturación. Leer un pedido por id es heredado, pero la lista de pedidos es estricta, así que un pedido que puedes abrir por id puede no aparecer en tu lista.
Qué obtienes fuera de tu aislamiento
Enlace a esta sección: Qué obtienes fuera de tu aislamiento| Tú haces | Resultado | Por qué |
|---|---|---|
| Leer un recurso fuera del aislamiento de tu clave | 404 not_found | Es idéntico a que el recurso no exista. La API nunca revela que existe. |
Escribir un cuerpo que referencia un identificador fuera de tu aislamiento, como el contactId de un pedido | 400 validation_error que nombra el campo, y no se escribe nada | El mensaje es el mismo tanto si el identificador no existe como si pertenece a otra cuenta, de modo que no sirve para sondear ninguno de los dos casos. Es un 400 porque lo que está mal es el cuerpo, no la ruta. |
Un 404 no siempre es un registro eliminado
Si un registro desaparece de tu sincronización con un 404, puede que se haya eliminado, archivado o que nunca haya estado en tu aislamiento. Confírmalo antes de eliminar nada por tu parte; Sincronizar datos explica cómo.
Las integraciones que dan servicio a varias empresas de alquiler necesitan una clave por cuenta de cliente; consulta Integraciones con varias cuentas. Las mismas ideas en la app se explican en Preferencias del espacio de trabajo.
Páginas relacionadas
Enlace a esta sección: Páginas relacionadasConceptos básicos
Registros e ids
Cada registro tiene un id opaco que asigna Filmo. Guarda tus propios ids en una tabla de correspondencias de tu lado, y usa un campo de referencia solo donde la API lo tenga.
Conceptos básicos
Permisos
Un rechazo tiene tres causas distintas: la clave no tiene un scope, el propietario de la clave no tiene un permiso, o la cuenta no tiene un add-on. Cada una tiene un estado o código distinto y una solución distinta.
Guías
Integraciones con varias cuentas
Da a cada cuenta de cliente su propia credencial, guárdala con la zona horaria y la moneda de esa cuenta, y trata una credencial que falla como el estado de una conexión, no de todo tu producto. OAuth está disponible para un servidor que ejecutes tú, y las claves de API son más sencillas para el trabajo entre servidores.
¿Te ha resultado útil esta página?