Desarrolladores: integrar tu software con la API de Beply
Archivos adjuntos
Gestión de archivos y adjuntos asociados a recursos de Beply.
Actualizado el 22 de octubre de 2026
Subir archivos y vincularlos a un registro con la API
Adjuntar un archivo a un registro son dos pasos: subir el fichero y crear la relación con el registro.
Aplicabilidad: API versión 3 · Plan Profesional, con la API activada en el servicio.
1. Subir el archivo
curl -s -X POST "$BEPLY_URL/api/3/uploadFiles" -H "Token: $BEPLY_TOKEN" \
-F "files[]=@contrato-ejemplo.pdf"
Respuesta: {"files": [{"idfile": 1001, "filename": "contrato-ejemplo.pdf", "mimetype": "application/pdf", "size": 52344, "date": "…", "hour": "…", "path": "…"}]}. Guarda idfile.
- Se pueden enviar varios
files[]en la misma petición. - Los archivos PHP se rechazan y no aparecen en la respuesta. Si la lista llega vacía, el archivo no se guardó: revisa tipo y tamaño.
- Si ya existe un archivo con el mismo nombre, se guarda con un prefijo numérico; el
idfilees siempre nuevo. Subir dos veces el mismo fichero crea dos archivos.
2. Vincularlo a un registro
curl -s -X POST "$BEPLY_URL/api/3/attachedfilerelations" -H "Token: $BEPLY_TOKEN" \
--data-urlencode "idfile=1001" \
--data-urlencode "model=FacturaCliente" \
--data-urlencode "modelid=<IDFACTURA>"
| Campo | Uso |
|---|---|
idfile | Archivo devuelto en el paso 1. |
model | Nombre del modelo del registro: Cliente, FacturaCliente, Producto… |
modelid / modelcode | Identificador numérico o código del registro. |
observations | Nota opcional. |
Comprueba el resultado
En el programa, el archivo aparece en la pestaña de archivos del registro (ver Adjuntar y consultar archivos). Por API: GET /api/3/attachedfilerelations?filter[model]=FacturaCliente&filter[modelid]=<IDFACTURA>.
Si algo falla
Si la subida funcionó pero la relación falló, no vuelvas a subir el archivo: repite solo el paso 2 con el mismo idfile. Los metadatos se consultan en attachedfiles.