API REST de Beply

La API REST de Beply te permite automatizar toda la gestión empresarial desde tu propio software: facturas con VeriFactu, clientes, productos, presupuestos, albaranes, pedidos, contabilidad, stocks, archivos adjuntos y mucho más.

En 30 segundos

• URL base: https://<tu-instancia>.beply.es/api/3/
• Versión actual: 3
• Formato de envío: application/x-www-form-urlencoded como un formulario HTML
• Formato de respuesta: siempre application/json
• Autenticación: cabecera Token: <tu-api-key>

curl https://miempresa.beply.es/api/3/clientes \
  -H "Token: tu-api-key-aquí"

Capítulos

Capítulo	Qué resuelve
01 - Autenticación	Crear API Keys y enviar la cabecera Token.
02 - Listar, filtrar y ordenar	Paginación, filtros, operadores, ordenación y búsquedas.
03 - CRUD básico	Crear, leer, actualizar, eliminar y descubrir campos con /schema.
04 - Facturas	Crear facturas completas, marcar pagadas, rectificativas y exportar PDF.
05 - Otros documentos	Presupuestos, pedidos y albaranes de cliente/proveedor.
06 - Archivos adjuntos	Subir ficheros y vincularlos a clientes, facturas u otros registros.
07 - Errores y validaciones	Códigos HTTP, mensajes JSON y errores comunes.

Recursos vs funciones

Tipo	Convención	Cuándo usarlo
Recursos de datos	Minúsculas y plural: clientes, productos, facturaclientes	CRUD estándar sobre modelos de dominio.
Funciones	camelCase: crearFacturaCliente, pagarFacturaCliente	Flujos compuestos que requieren varias operaciones internas.

Recursos más usados

• clientes, proveedores, productos
• facturaclientes / facturaproveedores
• albaranclientes / albaranproveedores
• pedidoclientes / pedidoproveedores
• presupuestoclientes / presupuestoproveedores
• pagoclientes / pagoproveedores
• attachedfiles / attachedfilerelations
• apikeyes, users, roles

Los nombres siguen la convención <entidad-en-singular> + clientes o proveedores: factura + clientes = facturaclientes, no facturasclientes.