La API REST de FacturaScripts

La API de FacturaScripts ofrece a los programadores una forma sencilla de acceder, crear, modificar y eliminar datos de FacturaScripts desde aplicaciones externas.

¿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/3

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

Autenticación con la API

Para activar la API debemos ir al menú administrador, panel de control. En el apartado "Por defecto", en la parte de abajo, debemos marcar la casilla Activar API y pulsar 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/3
• 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

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