La API REST de FacturaScripts

La API nos ofrece una forma sencilla de comunicar con los recursos disponibles, mediante unos métodos concretos y simples a los que podemos denominar en su conjunto como CRUD, por su acrónimo en inglés:

  • POST: Crear (Create) un elemento nuevo.
  • GET: Leer (Read) una lista de elementos o un elemento, en listados con paginación, filtros y/o ordenación, o elementos concretos. Este es el método que se utiliza por defecto.
  • PUT: Actualizar (Update) un elemento concreto.
  • DELETE: Eliminar (Delete) un elemento concreto.

¿Cómo usarla?

Para acceder a la API de FacturaScripts, añade /api al final de la url donde tengas FacturaScripts. Para este ejemplo, como tengo instalado FacturaScripts en localhost:8000, la url de la API es: http://localhost:8000/api

Para simplificar los ejemplos a continuación se va a utilizar Insomnia para realizar las consultas contra la API y recibir una respuesta formateada que sea más legible.

Autenticación con la API

Para usar la API primero debemos activarla, crear una clave y darle unos permisos:

  • Para activar la API basta con dirigirse al menú administrador, panel de control, apartado Por defecto. Una vez ahí marcamos la opción de Activar API y pulsamos Guardar.
  • Ahora hacemos clic en la sección API Keys, pulsamos el botón nuevo y creamos una nueva clave con la casilla "acceso completo" marcada.

Bien, ahora ya podemos conectar:

  • Abrimos insomnia.
  • Introducimos la url de la API, en este caso http://localhost:8000/api
  • Nos vamos a la pestaña header y añadimos el campo Token con nuestra clave de API como valor.

API-VERSION-NOT-FOUND

api version not found

  • Este error indica que no hemos seleccionado la versión de la API.
  • La API está diseñada para soportar múltiples versiones, aunque por ahora solamente usaremos la versión 3.
  • La url de la versión 3 es: http://localhost:8000/api/3

listado de recursos

En el apartado resources tenemos todos los recursos o endpoints accesibles a través de la API.


  Siguiente

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

Iniciar sesión
neorazorx_1
neorazorx_1

España, 8 años, nivel 100

Fecha de creación 01-05-2018 00:00:00
Última actualización 06-08-2021
Contador de visitas 5726

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
elurk_3992
ORO
mgmultigestion_11543
PLATA
prebac_1378
PLATA
yolandass_1347
BRONCE
ldardon_11876
BRONCE
necatorem_12616
BRONCE
omegatech.ventas_1859
Patrocinar

Amplíe sus conocimientos con los cursos oficiales

Curso básico de usuario

Con este curso aprenderá a gestionar el día a día de su negocio con FacturaScripts 2021: hacer facturas, albaranes, pedidos y presupuestos. Gestionar clientes, proveedores y tarifas. Y a realizar la regularización de impuestos (trimestre de IVA). ¿A quién va dirigido? A cualquier usuario que ya tenga FacturaScripts instalado en su PC o hosting y quiera aprender rápidamente el manejo diario del programa. ¿Qué incluye? 18 lecciones con 17 vídeos explicativos.

227 4,99 €
Curso básico de programación

Con este curso aprenderá cómo crear un plugin sencillo para FacturaScripts 2021: 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. ¿Qué incluye? 18 lecciones con 14 vídeos explicativos.

237 8,99 €
Sesiones de programación 2021

Esta es una recopilación de vídeos y documentación de pequeños desarrollos sobre FacturaScripts 2021 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? 9 lecciones con 9 vídeos explicativos (más de 5 horas de vídeos) y el código fuente de los ejemplos. Novedades mensuales: Este curso se amplía cada mes con nuevas lecciones.

41 14,99 €

Copyright (c) 2013-2021 FacturaScripts