Conceptos básicos

Planes y add-ons

La API y el MCP están incluidos en cualquier plan de pago; no son un add-on. El acceso necesita un administrador y que Filmo haya activado la API para tu entorno; algunos módulos necesitan su add-on. Llama a GET /api/v1/account para ver qué add-ons tiene hoy la cuenta.

La API y el servidor MCP están incluidos en cualquier plan de pago y no son un add-on: la API no comprueba el plan ni ningún add-on para dejar entrar a una clave. El acceso necesita dos cosas: que Filmo haya activado la API y el MCP para el entorno en el que vive tu cuenta (un interruptor del lado de Filmo, no un ajuste de la cuenta) y que un administrador cree la clave o apruebe la conexión OAuth. Los límites de peticiones son los mismos para todos los planes. Los módulos que tienen un add-on lo conservan, como explica el apartado siguiente. El centro de ayuda trata la suscripción en Tu suscripción.

Algunos módulos están tras un add-on. Si la cuenta no lo ha contratado, o lo ha dejado caducar, una operación de ese módulo responde 402 addon_required y requiredAddon nombra el add-on. Es un 402 y no un 403 porque se trata del add-on, no de los permisos. La respuesta es por recurso: la misma clave puede llamar a otros recursos de la cuenta sin ningún add-on.

Add-onAbre
crmOportunidades y embudos
incidenceIncidencias y tickets de reparación
purchasesÓrdenes de compra, facturas de proveedor y actualizaciones de subalquileres
custom-fieldsDefiniciones de campos personalizados
Crédito de IAPOST /api/v1/ai/ask. Sin cuota responde 402

Esa tabla nombra los principales add-ons. Los ids salen de un catálogo cerrado: addons lista los que tiene la cuenta, y cada operación que puede responder 402 nombra su add-on en la extensión x-required-addon de la especificación. Algunas operaciones ajenas a esos módulos también pueden responder 402.

La lista se genera a partir de las respuestas 402 que declara la especificación. Cada operación de la lista indica su add-on.

OperaciónPermiso
GET /api/v1/repair-ticketsrepair-tickets:read
POST /api/v1/repair-ticketsrepair-tickets:write
GET /api/v1/repair-tickets/{ticketId}repair-tickets:read
PATCH /api/v1/repair-tickets/{ticketId}repair-tickets:write
PATCH /api/v1/subrents/{subrentId}subrents:write
GET /api/v1/purchase-orderspurchase-orders:read
GET /api/v1/purchase-orders/{purchaseOrderId}purchase-orders:read
PATCH /api/v1/purchase-orders/{purchaseOrderId}purchase-orders:write
GET /api/v1/custom-fieldscustom-fields:read
GET /api/v1/incidentsincidents:read
POST /api/v1/incidentsincidents:write
GET /api/v1/incidents/{incidentId}incidents:read
PATCH /api/v1/incidents/{incidentId}incidents:write
GET /api/v1/incidents/status-countsincidents:read
POST /api/v1/incidents/{incidentId}/commentsincidents:write
GET /api/v1/crm/opportunitiescrm:read
POST /api/v1/crm/opportunitiescrm:write
GET /api/v1/crm/opportunities/{opportunityId}crm:read
PATCH /api/v1/crm/opportunities/{opportunityId}crm:write
PATCH /api/v1/crm/opportunities/{opportunityId}/stagecrm:write
POST /api/v1/crm/opportunities/{opportunityId}/closecrm:write
POST /api/v1/crm/opportunities/{opportunityId}/linkscrm:write
GET /api/v1/crm/pipelinescrm:read
GET /api/v1/crm/pipelines/{pipelineId}crm:read
POST /api/v1/purchase-orders/{purchaseOrderId}/approvepurchase-orders:write
POST /api/v1/purchase-orders/{purchaseOrderId}/receivepurchase-orders:write
GET /api/v1/supplier-invoicessupplier-invoices:read
GET /api/v1/supplier-invoices/{supplierInvoiceId}supplier-invoices:read
POST /api/v1/ai/askai:ask
POST /api/v1/invoices/{invoiceId}/validateinvoices:write
PUT /api/v1/invoices/external/{originSystem}/{originExternalId}invoices:write
PATCH /api/v1/proformas/{proformaId}/statusinvoices:write
PATCH /api/v1/quotes/{quoteId}/statusquotes:write
POST /api/v1/contracts/{contractId}/validatecontracts:write
POST /api/v1/contracts/{contractId}/signcontracts:write
POST /api/v1/supplier-invoices/{supplierInvoiceId}/validatesupplier-invoices:write
POST /api/v1/supplier-invoices/{supplierInvoiceId}/voidsupplier-invoices:write

GET /api/v1/account devuelve addons, los add-ons a los que la cuenta tiene acceso hoy. Léelo al arrancar y antes de llamar a un recurso que esté detrás de un add-on. El servidor MCP lista solo las herramientas que la clave puede llamar.

Una prueba gratuita dura 14 días y no necesita tarjeta. Durante ella un administrador puede crear claves y conectar OAuth y MCP, como en cualquier cuenta, así que sirve para probar la API. trial tiene active, true mientras dura la prueba, y endsAt. Mientras una prueba está activa todos los add-ons están desbloqueados, así que lo que construyas durante ella puede empezar a responder 402 después.

  • Cuando termina la prueba, las claves y las conexiones OAuth no se revocan, y la autenticación no mira la prueba. Los endpoints que dependen de un add-on responden 402 addon_required; los endpoints que no necesitan add-on siguen funcionando.
  • Validar una factura o una nota de crédito en una cuenta de prueba consume números de su numeración. Valida solo lo que necesite una prueba.
  • Filmo purga los datos de una cuenta cuya prueba terminó y que no se ha convertido en una suscripción de pago unos 30 días después del final.
  • Lee addons en la cuenta que vayas a usar en producción, no solo en la de prueba, y gestiona addon_required de forma explícita.

La guía de pruebas está en Pruebas, y el centro de ayuda trata la facturación en Tu suscripción.

  • 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.

  • Primeros pasos

    Guía rápida

    Crea una clave de API en la sección API y MCP de los ajustes de Filmo y luego llama a GET /api/v1/account. La respuesta te dice la zona horaria, la moneda, los add-ons y los permisos (scopes) con los que construir.

  • Guías

    Probar tu integración

    Empieza con una clave de solo lectura, revisa las automatizaciones de la cuenta antes de la primera escritura y mantén las operaciones irreversibles fuera de cualquier cuenta que contenga datos reales.

¿Te ha resultado útil esta página?