API¶

La API de Gem Logic le permite integrar sistemas externos y automatizar flujos de trabajo. Puede utilizarla para gestionar productos, ventas, contactos, reparaciones, inventarios y trabajos de impresión de forma programática.

Acceda a Configuración ‣ API para crear y gestionar sus claves API.

Autenticación¶

Todas las solicitudes API deben incluir una clave API en el encabezado HTTP x-api-key. Puede crear claves desde la página Configuración ‣ API. Las claves pueden desactivarse o eliminarse en cualquier momento.

Ejemplo de solicitud:

curl -X GET https://your-instance.gem-logic.com/api/marketplaces/ \
  -H "x-api-key: YOUR_API_KEY"

Peligro

Mantenga sus claves API en secreto. No las comparta nunca en repositorios públicos o código del lado del cliente. Si una clave se ve comprometida, desactívela inmediatamente y cree una nueva.

URL base¶

Todos los endpoints son relativos a la URL de su instancia, bajo el prefijo /api/:

https://your-instance.gem-logic.com/api/

Formato de respuesta¶

Todas las respuestas se devuelven en formato JSON. Las solicitudes exitosas devuelven un código de estado 200 (para GET) o 201 (para POST). Los errores devuelven el código de estado apropiado con un mensaje:

200 OK — solicitud GET exitosa
201 Created — solicitud POST exitosa
400 Bad Request — datos inválidos o faltantes
401 Unauthorized — clave API inválida o faltante
404 Not Found — el recurso no existe

Endpoints¶

Canales de venta¶

Método	`GET`
URL	`/api/marketplaces/`
Descripción	Devuelve una lista de todos los canales de venta.

Campos de respuesta:

Campo	Tipo	Descripción
`id`	integer	Identificador único
`marketplace`	string	Nombre del marketplace

Productos¶

Listar productos

Método	`GET`
URL	`/api/products/{marketplace_id}`
Descripción	Devuelve los productos filtrados por marketplace. Utilice el ID de marketplace del punto de terminación marketplaces.

Campos de respuesta:

Campo	Tipo	Descripción
`id`	integer	Identificador único
`item_sku`	string	SKU del producto
`created`	datetime	Fecha de creación
`status`	string	Estado del producto
`images`	array	Lista de imágenes del producto (`id`, `image`)
`item_weight`	decimal	Peso
`item_height`	decimal	Altura
`item_length`	decimal	Longitud
`item_width`	decimal	Ancho

Crear imagen de producto

Método	`POST`
URL	`/api/products/create/image/`
Descripción	Carga una imagen de producto utilizando codificación base64. Si el SKU del producto no existe todavía, se crea un nuevo producto automáticamente.

Campos de la solicitud:

Campo	Tipo	Requerido	Descripción
`item_sku`	string	Sí	SKU del producto al que adjuntar la imagen
`image`	string (base64)	Sí	Datos de imagen codificados en base64

Ventas¶

Listar ventas

Método	`GET`
URL	`/api/sales/`
Descripción	Devuelve una lista de todos los pedidos de venta.

Campos de respuesta:

Campo	Tipo	Descripción
`order_id`	string	Identificador único del pedido

Crear venta

Método	`POST`
URL	`/api/sales/create/`
Descripción	Crea un nuevo pedido de venta.

Contactos¶

Método	`GET`
URL	`/api/contacts/`
Descripción	Devuelve una lista de todos los contactos.

Campos de respuesta:

Campo	Tipo	Descripción
`id`	integer	Identificador único
`complete_name`	string	Nombre completo
`contact_type`	string	Tipo de contacto
`email`	string	Dirección de correo electrónico
`phone`	string	Número de teléfono
`language`	string	Idioma preferido

Reparaciones¶

Crear reparación

Método	`POST`
URL	`/api/repairs/create/`
Descripción	Crea un nuevo pedido de reparación con un artículo de reparación asociado. Si no se proporciona el punto de venta o la división, se utiliza el primero disponible.

Campos de la solicitud:

Campo	Tipo	Requerido	Descripción
`client_id`	integer	No	ID del cliente/contacto
`marketplace`	cadena / entero	No	ID o nombre del punto de venta
`division_id`	integer	No	ID de la división comercial
`title`	string	No	Título o descripción del artículo de reparación
`repair_info_1`	string	No	Comentario de reparación adicional
`repair_info_2`	string	No	Comentario de reparación adicional
`repair_info_3`	string	No	Comentario de reparación adicional
`quantity`	decimal	No	Cantidad (predeterminado: 1)
`weight`	decimal	No	Peso del artículo
`weight_unit`	string	No	Unidad de medida del peso
`size`	string	No	Tamaño del artículo
`color`	string	No	Color del artículo
`engravement`	string	No	Texto del grabado
`client_reference` \| string		No	Número de referencia del cliente

Ejemplo de respuesta:

{"message": "Repair created successfully.", "order_id": "R-0001"}

Añadir artículo a reparación

Método	`POST`
URL	`/api/repairs/add-item/`
Descripción	Añade un nuevo artículo a una orden de reparación existente.

Campos de la solicitud:

Campo	Tipo	Requerido	Descripción
`order_id`	string	Sí	ID de la orden de reparación a la que añadir el artículo
`item_sku`	string	No	SKU del producto a vincular con el artículo
`title`	string	No	Título o descripción
`repair_info_1`	string	No	Comentario de reparación adicional
`repair_info_2`	string	No	Comentario de reparación adicional
`repair_info_3`	string	No	Comentario de reparación adicional
`quantity`	decimal	No	Cantidad (predeterminado: 1)
`weight`	decimal	No	Peso del artículo
`weight_unit`	string	No	Unidad de medida del peso
`size`	string	No	Tamaño del artículo
`color`	string	No	Color del artículo
`engravement`	string	No	Texto del grabado
`client_reference` \| string		No	Número de referencia del cliente
`cost`	decimal	No	Coste del artículo

Recuentos de inventario¶

Crear recuento de inventario

Método	`POST`
URL	`/api/inventory-counts/`
Descripción	Crea una nueva sesión de recuento de inventario.

Campos de respuesta:

Campo	Tipo	Descripción
`id`	string	ID del recuento de inventario
`created_at`	datetime	Marca de tiempo de creación
`status`	string	Siempre `active`
`tag_count`	integer	Número de productos contados

Listar productos del recuento de inventario

Método	`GET`
URL	`/api/inventory-counts/{inventory_count_id}/products/`
Descripción	Devuelve todos los productos contados en un recuento de inventario específico.

Campos de respuesta:

Campo	Tipo	Descripción
`id`	string	Identificador único
`created_at`	datetime	Cuándo se contó el producto
`product_sku`	string	SKU del producto
`product_name`	string	Nombre del producto
`quantity`	integer	Cantidad contada

Trabajos de impresión¶

Método	`POST`
URL	`/api/print-pdf/`
Descripción	Carga un archivo PDF en la cola de impresión para una impresora específica. El archivo se valida en formato y seguridad. Tamaño máximo de archivo: 20 MB. Use el tipo de contenido `multipart/form-data`.

Campos de la solicitud:

Campo	Tipo	Requerido	Descripción
`pdf`	archivo	Sí	Archivo PDF para imprimir (máx. 20 MB)
`printer_uuid`	UUID	Sí	UUID de la impresora de destino
`landscape`	booleano	No	Imprimir en modo apaisado (por defecto: false)

Ejemplo de solicitud:

curl -X POST https://your-instance.gem-logic.com/api/print-pdf/ \
  -H "x-api-key: YOUR_API_KEY" \
  -F "pdf=@document.pdf" \
  -F "printer_uuid=YOUR_PRINTER_UUID"

Ejemplo de respuesta:

{"status": "queued", "print_job_id": 42}

Explorador interactivo de API¶

Gem Logic incluye un explorador de API interactivo integrado basado en Swagger UI. Puede acceder a él desde el enlace Documentación de la API en la página Configuración ‣ API. El explorador le permite probar cada punto de conexión directamente desde su navegador.

Ver también

Integraciones