Listado de Recursos Disponibles en la API (Modelos)

Al acceder a la API indicando únicamente la versión, obtendremos un listado con todos los recursos disponibles a través de la API, tales como agencias de transporte, agentes, albaranes de cliente, entre otros.

Ejemplo de solicitud

http://localhost:8000/api/3

Puedes consultar cada uno de estos recursos agregando el nombre del recurso a la URL:

Asegúrate de que estás realizando una consulta de tipo GET.

📝 Añadir un endpoint

Puedes añadir endpoints a la API desde tus plugins siguiendo la guía de creación de endpoints para la API.

🚫 Ocultar modelos de la API

No todos los modelos deben exponerse. El core ya excluye del listado los modelos auxiliares CodeModel y TotalModel.

Desde la versión 2026.65, los plugins pueden excluir sus propios modelos llamando a APIModel::excludeModel() desde la función init() del archivo Init.php, indicando el nombre de la clase sin namespace:

<?php
namespace FacturaScripts\Plugins\MyNewPlugin;

use FacturaScripts\Core\Lib\API\APIModel;
use FacturaScripts\Core\Template\InitClass;

class Init extends InitClass
{
    public function init(): void
    {
        APIModel::excludeModel('MiModeloInterno');
    }
}

El modelo excluido deja de aparecer en el listado de recursos y, además, su endpoint queda inaccesible: cualquier petición a /api/3/mimodelointernos devuelve el error api-resource-invalid.

Anterior Siguiente