Esta web utiliza cookies propias y de terceros para su funcionamiento. ¿Aceptas? Leer más
Desarrollo sobre FacturaScripts 2018

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 a Administrador -> Panel de control -> Preferencias de aplicación, activar la opción de Activar API y Guardar.
  • Ahora hacemos clic en el menú Administrador -> Panel de control -> API Keys y creamos una nueva clave.
  • Por último, en la pestaña reglas, pulsamos el botón añadir todo habilitado.

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

  • 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

Todavía más: