Añadir un endpoint a la API

Con los últimos cambios en la versión 2023.1 ahora es más sencillo añadir endpoints a la API, gracias al nuevo sistema de enrutamiento. Solamente tenemos que crear un controlador que herede de ApiController y dar de alta 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 enlazarla con el nuevo controlador.

<?php
namespace FacturaScripts\Plugins\MyNewPlugin;

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

class Init extends InitClass
{
    public function init()
    {
        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 enlazado 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']));
    }
}

Siguiente Pregunta al chatbot

Necesita identificarse para continuar con esta acción. Haga clic en iniciar sesión o cree una cuenta.

Iniciar sesión

PRO

neorazorx_1

España, 11 años, nivel 100

Fecha de creación: 23-11-2023 17:40:18
Última actualización: 17-08-2024
Contador de visitas: 505

Creación de plugins

Patrocinadores

FacturaScripts avanza más rápido gracias al apoyo financiero de los patrocinadores, que contribuyen a que podamos dedicar más tiempo al desarrollo, testeo y documentación. Usted también puede poner su granito de arena y convertirse en patrocinador ;-)

ORO

PLATA

BRONCE

PRO

Patrocinar

Amplíe sus conocimientos con los cursos oficiales

Curso básico de PHP

¡Aprende a programar en PHP de manera fácil y divertida con nuestro curso básico! En este curso, te enseñaremos los conceptos fundamentales de la programación en PHP, incluyendo la sintaxis básica, el manejo de variables, estructuras de control de flujo y mucho más. Al terminar estarás listo para comenzar con el curso de creación de plugins para FacturaScripts.

9,99 €

Curso básico de programación

Con este curso aprenderá cómo crear un plugin sencillo para FacturaScripts: añadir nuevas páginas, tablas y columnas. Para entender este curso no se necesita mucha experiencia en programación, le enseñaremos los básico para modelar problemas sencillos. ¿A quién va dirigido? A cualquier persona con unos conocimientos muy básicos de programación o que ya han completado el curso de PHP. ¿Qué incluye? 18 lecciones con 14 vídeos explicativos.

361

9,99 €

Sesiones de programación

Esta es una recopilación de vídeos y documentación de pequeños desarrollos sobre FacturaScripts y sus plugins. Perfecto para expandir tus conocimientos de programación. ¿A quién va dirigido? A personas que ya hayan superado el curso básico de programación y busquen ampliar sus conocimientos. ¿Qué incluye? 22 lecciones con 22 vídeos explicativos (más de 11 horas de vídeos) y el código fuente de los ejemplos.

141

19,99 €