Para saber más
Datos que la API deja fuera
La API pública deja fuera a propósito los datos sensibles para el negocio: costes, márgenes, códigos de acceso, documentos fiscales internos y nóminas o datos personales del personal. Trata un campo que no está en el esquema de respuesta como no disponible.
La descripción de la API enuncia la regla: los campos sensibles para el negocio se excluyen por diseño del borde público. Por tanto, un campo que falta en una respuesta no es un error ni un problema de permisos, y un permiso (scope) no lo desbloqueará. El esquema de respuesta de la versión que llamas es la fuente de verdad de lo que se publica.
Qué se deja fuera y dónde
Enlace a esta sección: Qué se deja fuera y dóndeLa descripción de cada recurso dice qué no publica. Estos son los casos que nombra:
| Área | Qué no se publica |
|---|---|
| Espacios | Los costes de mantenimiento del espacio. |
| Tickets de reparación | El coste de la reparación. El unitPrice es un precio de venta, no un coste. |
| Vehículos | El coste por kilómetro y el coste fijo. |
| Personal | Datos de contacto, identidad, nómina y acceso a la plataforma, al leer y al escribir. |
| Subalquileres | El precio del proveedor. |
| Tesorería | El número de la cuenta bancaria. Referencia una cuenta por su identificador. |
| Servicios | El coste y el nombre interno del servicio. |
| Notas de crédito | El documento fiscal firmado, el desglose de impuestos y las líneas. |
| Incidencias | El coste de la reparación y la nota interna de resolución. |
| Órdenes de compra | Las líneas. Los importes son costes porque el objeto es una compra, así que el gasto no se puede atribuir a un artículo de alquiler concreto. |
| Notas | Quién escribió la nota. |
Considera la lista como los casos documentados hoy, no como un inventario completo. Si un campo que necesitas no está en el esquema de la respuesta, no está disponible.
Qué hacer si lo necesitas
Enlace a esta sección: Qué hacer si lo necesitas- Usa la app. Las personas de tu equipo que tienen el permiso ven allí estos datos.
- No deduzcas los costes de otros campos. Por ejemplo, un precio de venta no es un coste.
- Si tu integración necesita un campo que no está expuesto, cuéntale al soporte qué intentas hacer en lugar de qué campo quieres; consulta la página de soporte.
Los campos nunca se eliminan dentro de una versión mayor, y se añaden campos nuevos sin aviso, así que tu cliente debe ignorar las propiedades que no conozca. Consulta versiones. Para otras cosas que la API no hace, consulta capacidades y límites.
Páginas relacionadas
Enlace a esta sección: Páginas relacionadasPara saber más
Capacidades y límites de la v1
La API cubre la mayor parte del trabajo diario con pedidos, contactos, artículos, facturas y la agenda, y deja una lista corta de cosas a la app. Compruébalo aquí antes de diseñar una integración en torno a una función.
Guías
Versionado y obsolescencia
Dentro de v1 Filmo solo añade cosas. Cualquier cosa que pueda romper tu integración se anuncia antes, ya sea como una nueva versión mayor o como una obsolescencia con al menos seis meses antes de la retirada.
¿Te ha resultado útil esta página?