• Antes de empezar a programar +
  • ¿Qué versión de Symfony utiliza?
  • Sistema de Prioridades de Plugins
  • Diagramas de tablas
  • Cómo hacer un pull-request
• Creación de Plugins +
  • El archivo facturascripts.ini
  • El archivo Init.php
  • Los Controladores +
    • Controladores extendidos +
      • ListController en FacturaScripts +
        • addFilterAutocomplete()
        • addFilterCheckbox()
        • addFilterDatePicker()
        • addFilterNumber()
        • addFilterPeriod()
        • addFilterSelect()
        • addFilterSelectWhere()
      • EditController
      • PanelController +
        • addHtmlView()
        • addEditView()
        • addEditListView()
        • addListView()
      • Personalizando con Settings
      • Método disableColumn()
      • Interacción con las Vistas
    • Obtener Parámetros de la URL, Formularios o Cookies
    • Cómo guardar una cookie
    • Consultar el usuario y sus permisos
    • Formularios de edición de facturas, albaranes, etc
  • Añadir un Endpoint a la API
  • Los modelos +
    • Operaciones comunes con modelos
    • XML de la tabla
    • ModelOnChangeClass
    • Modelos de Más de Una Tabla
    • Modelos Especiales
    • Cómo crear una factura, albarán, pedido o presupuesto
    • Herencia de Modelos
    • $modelo->install()
    • $modelo->all()
    • $modelo->clear()
    • $modelo->count()
    • $modelo->delete()
    • $modelo->exists()
    • $modelo->loadFromData()
    • $modelo->get()
    • $modelo->getModelFields()
    • $modelo->loadFromCode()
    • $modelo->primaryColumnValue()
    • $modelo->primaryColumn()
    • $modelo->newCode()
    • $modelo->tableName()
    • $modelo->save()
    • $modelo->primaryDescription()
    • $modelo->primaryDescriptionColumn()
    • $modelo->url()
    • $modelo->test()
  • Las vistas HTML +
    • Iconos disponibles
    • Herencia de plantillas
  • Las vistas XML (XMLView) +
    • Columns
    • Rows +
      • Row status
      • Row statistics
      • Row actions
      • Row header y footer
    • Modals
    • Group
    • Column
    • Widgets +
      • Widget Autocomplete
      • Widget Bytes
      • Widget Checkbox
      • Widget Color
      • Widget Datalist
      • Widget Date
      • Widget Datetime
      • Widget File
      • Widget Library
      • Widget Link
      • Widget Money
      • Widget Number
      • Widget Password
      • Widget Select
      • Widget Stars
      • Widget Text
      • Widget Textarea
      • Widget Time
      • Widget Radio
      • Widget Variante
  • Las traducciones en Plugins
  • Las extensiones +
    • Extensiones de controladores
    • Extensiones de modelos
    • Extensiones de tablas
    • Extensiones de XMLView
    • Extensiones de Vistas HTML
  • Mostrar mensajes, errores y alertas
  • Acceso a la Base de Datos +
    • DbQuery
    • Where
    • DataBaseWhere
  • Settings: opciones del panel de control +
    • Cómo crear preferencias de aplicación para su plugin
  • Generación de PDF y Excel
  • AssetManager
  • El archivo Cron.php
  • Cómo publicar plugins
• Profundizando en el CORE +
  • Enrutado
  • Gestión de Errores
  • Gestión de Plugins
  • Uso de la caché
  • La cola de trabajos
  • Descarga de Archivos desde MyFiles
  • Cliente de API de OpenAI
  • Cliente HTTP +
    • Conectar con otro FacturaScripts mediante API
  • Validar Emails, Cadenas y URLs
  • Enviar emails con NewMail
• Test unitarios en plugins
• Migración de plugins antiguos +
  • Row Business (Obsoleto)
  • Migrar los XML de las tablas de 2017
  • Migrar Modelos de 2017
  • addGridView() - (obsoleto)
• La API REST
  • Listado de recursos
  • Listar, filtrar y ordenar registros
  • Obtener un registro concreto
  • Crear o añadir registros
  • Cómo crear facturas
  • Obtener el PDF de una factura
  • Modificar registros
  • Eliminar registros

Guía de la API REST

La API REST de FacturaScripts ofrece a los desarrolladores una forma sencilla de acceder, crear, modificar y eliminar datos desde aplicaciones externas.

¿Cómo usar la API?

Para acceder a la API de FacturaScripts, añade /api al final de la URL donde tienes instalado FacturaScripts. Por ejemplo, si tienes FacturaScripts instalado en localhost:8000, la URL de la API será: http://localhost:8000/api/3.

A continuación, utilizaremos Insomnia para realizar las consultas a la API y recibir respuestas en un formato más legible.

Activación y autenticación de la API

1. Activar la API: Dirígete al menú Administrador y selecciona Panel de control. En la sección Por defecto, marca la casilla Activar API y haz clic en Guardar.

   

2. Crear una API Key: Haz clic en la sección API Keys y presiona el botón Nuevo para crear una nueva clave. Asegúrate de marcar la opción Acceso completo.

   

Una vez que hayas creado la API Key, puedes conectarte a la API realizando los siguientes pasos:

• Abre Insomnia.
• Introduce la URL de la API (http://localhost:8000/api/3) y asegúrate de que se está realizando una petición de tipo GET.
• Ve a la pestaña Headers y agrega el campo Token con tu clave de API como valor.

Error API-VERSION-NOT-FOUND

Este error indica que no se ha seleccionado la versión de la API. La API está diseñada para soportar múltiples versiones, aunque por el momento solo utilizaremos la versión 3. La URL correspondiente a la versión 3 es: http://localhost:8000/api/3.

En la sección Resources, puedes encontrar todos los recursos o endpoints accesibles a través de la API, como agencias de transporte, agentes, albaranes de cliente y albaranes de proveedor, entre otros.