INTRODUCCIÓN - Guía de instalación y uso.🔗
Instalación🔗
-
Desde FacturaScripts:
- Ve al apartado
Administrador
>Plugins
. - Busca "GraphQL" en el catálogo de plugins disponibles.
- Haz clic en
Instalar
y espera a que el proceso se complete.
- Ve al apartado
-
Descarga desde la Web:
- Visita el sitio oficial de plugins de FacturaScripts.
- Busca el plugin "GraphQL" y descarga el archivo
.zip
. - Desde tu instancia de FacturaScripts, ve a
Administrador
>Plugins
. - Selecciona la opción
Subir Plugin
y carga el archivo.zip
que descargaste. - Una vez subido, haz clic en
Instalar
.
Puesta en marcha🔗
-
Configuración inicial:
- Una vez instalado el plugin, ve a
Administrador
>Panel de Control
. - Activa la API y crea una
API key
que tenga acceso a todo. Más información sobre este proceso en La API REST de FacturaScripts.
- Una vez instalado el plugin, ve a
-
Utilización del Endpoint:
- El plugin creará un endpoint específico (por ejemplo,
/graphql
) donde podrás realizar tus consultas. - Accede al endpoint utilizando herramientas como Insomnia para realizar y probar tus consultas GraphQL.
- El plugin creará un endpoint específico (por ejemplo,
-
Realización de consultas:
- Consulta Ejemplo 1:
{ cliente(id: "12345") { nombre email facturas { numero fecha total } } }
- Consulta Ejemplo 2:
{ productos { descripcion familia referencia } }
- Consulta Ejemplo 1:
-
Herramienta de exploración:
- (En desarrollo).
-
Documentación automática:
- GraphQL tiene la ventaja de generar documentación en base a los esquemas definidos. Si el plugin la soporta, accede a la documentación para familiarizarte con los tipos y operaciones disponibles.
- GraphQL tiene la ventaja de generar documentación en base a los esquemas definidos. Si el plugin la soporta, accede a la documentación para familiarizarte con los tipos y operaciones disponibles.
Recomendaciones🔗
- Siempre asegúrate de tener una copia de seguridad antes de instalar o actualizar cualquier plugin.
- Revisa regularmente si hay actualizaciones para el plugin GraphQL para aprovechar nuevas características o correcciones de bugs.
Siguiente