• 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

Añadir un Endpoint a la API

Con los últimos cambios en la versión 2023.1, añadir endpoints a la API se ha vuelto más sencillo gracias al nuevo sistema de enrutamiento. La única acción necesaria es crear un controlador que herede de ApiController y registrar la nueva ruta en el archivo Init.php del plugin.

Añadir la ruta a la API

Desde el archivo Init.php de nuestro plugin, en su función init(), podemos añadir la nueva ruta a la API y vincularla con el nuevo controlador.

<?php
namespace FacturaScripts\Plugins\MyNewPlugin;

use FacturaScripts\Core\Template\InitClass;
use FacturaScripts\Core\Controller\ApiRoot;
use FacturaScripts\Core\Kernel;

class Init extends InitClass
{
    public function init(): void
    {
        Kernel::addRoute('/api/3/mi-endpoint', 'ApiControllerPruebas', -1);
        ApiRoot::addCustomResource('mi-endpoint');
    }
}

El ApiController

Para nuestro endpoint de API personalizado, necesitaremos un controlador, que es el que hemos vinculado en la ruta. Para este caso, crearemos el archivo ApiControllerPruebas.php en la carpeta Controller del plugin.

<?php
namespace FacturaScripts\Plugins\MyNewPlugin\Controller;

use FacturaScripts\Core\Template\ApiController;

class ApiControllerPruebas extends ApiController
{
    protected function runResource(): void
    {
        // Tu código aquí
        $this->response->setContent(json_encode(['hola' => 'mundo']));
    }
}

Ejemplo de Uso

Una vez que hayas creado el endpoint, podrás realizar peticiones a https://tusitio.com/api/3/mi-endpoint y recibirás la siguiente respuesta:

{
    "hola": "mundo"
}