Integration Guide

Crea aplicaciones, widgets y asistentes

Una guía práctica para usar la API pública de forma segura en sitios web externos, paneles, herramientas sin código, asistentes de IA y páginas de comparación de productos.

Referencia API OpenAPI JSON

Base URL

https://bulkworksuite.com/api/v1

Descubre la API

Empieza con el endpoint de estado para leer el nombre de la tienda, la URL base, los enlaces a la documentación y los endpoints disponibles.

Construir una vista de catálogo

Utiliza productos y categorías juntos para crear cuadrículas de productos, pantallas de búsqueda, páginas comparativas o widgets externos para tiendas.

Mantén los datos privados privados

La API pública expone solo los datos del catálogo. Las descargas, cuentas de clientes, pedidos y la titularidad de licencias siguen protegidos por los sistemas existentes de clientes y licencias.

Lo que puedes construir

Usa la API pública para integraciones reales de catálogos sin tocar datos privados de pago, cuenta, pedido o licencia.

External Catalogs

Render product grids, category filters, comparison tables, or partner storefront pages from public catalog data.

Bloques de revisión

Muestra las reseñas aprobadas y las insignias de valoración en las páginas de destino sin exponer los correos electrónicos de los clientes ni los registros de pedidos.

AI Assistants

Let assistants read public product facts, FAQs, releases, and store metadata while keeping private account data protected.

Widgets incrustables

Utiliza widgets JavaScript autónomos para tarjetas de productos, cuadrículas de productos, preguntas frecuentes, reseñas y insignias de valoración.

Sindicación de blogs

Extraiga las entradas de blog publicadas a sitios externos, boletines informativos o fuentes de contenido utilizando el punto final /api/v1/blog.

Forum Thread Feeds

Embed the latest public forum threads on your docs site, landing page, or community hub. Filter by subforum or category with a single data attribute.

Herramientas sin código

Conéctate a Zapier, Make (Integromat) o n8n utilizando los puntos finales GET públicos; no se requiere autenticación.

Registros de cambios de la versión

Muestra el historial de versiones públicas y los registros de cambios en tu sitio de documentación o página de producto sin exponer enlaces de descarga privados.

Búsqueda Unificada

Impulsar la búsqueda a nivel de sitio en productos, categorías y entradas de blog usando el endpoint /api/v1/search con ?q=.

Flujo de trabajo recomendado

Llama al endpoint de estado y almacena la URL base de la API desde la respuesta.
Obtén categorías para construir filtros y navegación.
Busca productos con paginación y filtros para las pantallas de anuncios.
Obtén un solo producto cuando un usuario abra una página de detalles.

Example Requests

Mapa de Endpoint

Estas son las rutas públicas de solo lectura disponibles para sitios web, widgets, herramientas sin código y asistentes.

GET Estado de la API

/api/v1

Retorna la identidad almacenada, endpoints habilitados y enlaces de documentación de la API.

Parámetros

No se requieren parámetros de consulta.

GET Metadatos de almacenamiento

/api/v1/store

Devoluciones la identidad de la tienda pública, la marca, los enlaces sociales y la disponibilidad de widgets.

Parámetros

No se requieren parámetros de consulta.

GET Productos

/api/v1/products

Listas publicadas, próximamente, y reservar productos con paginación y filtros.

Parámetros

page per_page search category type status sort min_price max_price featured coming_soon preorder

GET Producto único

/api/v1/product

Devuelve un producto público por slug o id con galería, preguntas frecuentes, metadatos de última versión y URLs públicas.

Parámetros

slug id

GET Categorías

/api/v1/categories

Lista categorías de tiendas públicas con el número de productos y URLs limpias de categorías.

Parámetros

No se requieren parámetros de consulta.

GET Preguntas frecuentes sobre tiendas

/api/v1/faqs

Devuelve las preguntas frecuentes activas de la página principal para constructores y asistentes externos.

Parámetros

product_id product_slug type limit

GET Reseñas

/api/v1/reviews

Solo devoluciones aprobadas por reseñas públicas.

Parámetros

product_id product_slug rating min_rating page per_page limit sort

GET Lanzamientos

/api/v1/releases

Devuelve los metadatos de lanzamiento público y de cambios sin rutas de descarga.

Parámetros

product_id product_slug limit page per_page

GET Blog Posts

/api/v1/blog

Lists published blog posts with pagination and search. Pass ?slug= for a single post with full HTML content.

Parámetros

page per_page q slug

GET Forum Threads

/api/v1/forum

Lists public forum threads with pagination, filters, and search. Pass ?slug= for a single thread with full HTML content. Only publicly accessible subforums are returned.

Parámetros

page per_page slug subforum category type solved q

GET Búsqueda

/api/v1/search

Busca productos públicos, categorías y contenido público del blog.

Parámetros

q type page per_page

GET Widgets

/api/v1/widgets

Devolve widgets incrustables disponibles y ejemplos de scripts seguros.

Parámetros

No se requieren parámetros de consulta.

GET OpenAPI

/api/v1/openapi.json

Descripción OpenAPI legible por máquina para la API pública.

Parámetros

No se requieren parámetros de consulta.

Forma de respuesta al éxito

Los extremos de lista devolven datos, paginación y metadatos de la API en un sobre JSON consistente.

{
    "success": true,
    "data": [],
    "pagination": {
        "page": 1,
        "per_page": 12,
        "total": 0,
        "total_pages": 1
    },
    "meta": {
        "api_version": "1.0",
        "generated_at": "2026-08-06T05:50:54+00:00"
    }
}

Forma de respuesta al error

Las solicitudes inválidas devuelven un objeto de error estable sin trazas de pila ni detalles SQL.

{
    "success": false,
    "error": {
        "code": "invalid_request",
        "message": "Human readable message"
    },
    "meta": {
        "api_version": "1.0",
        "generated_at": "2026-08-06T05:50:54+00:00"
    }
}

Paginación y filtros

Usa página y per_page para las pantallas de lista. La API limita las solicitudes grandes para que las páginas externas se mantengan rápidas y predecibles.

Products support search, category, type, status, price, featured, coming soon, preorder, and sort filters. Reviews and releases support product filters and limits.

Ejemplos de código

External apps can call the public GET endpoints directly. Check success before rendering returned data.

fetch('https://bulkworksuite.com/api/v1/products?per_page=6&category=digital-store')
  .then((response) => response.json())
  .then((json) => {
    if (!json.success) throw new Error(json.error.message);
    console.log(json.data, json.pagination);
  });

curl -s "https://bulkworksuite.com/api/v1/products?per_page=6&category=digital-store" | python3 -m json.tool

import requests

r = requests.get("https://bulkworksuite.com/api/v1/products?per_page=6&category=digital-store")
data = r.json()

if data["success"]:
    for product in data["data"]:
        print(product["title"], product["price"])
else:
    print("Error:", data["error"]["message"])

Widgets incrustables

Los widgets son scripts independientes con CSS con alcance limitado, escape seguro, estados de carga, estados vacíos y temas claros, oscuros o compactos.

Reviews

Approved review slider or list for a product.

Guion

https://bulkworksuite.com/widgets/reviews.js

Example Embed

<script src="https://bulkworksuite.com/widgets/reviews.js"
        data-product-slug="bulkwork-suite-self-hosted-digital-business-platform"
        data-limit="6"
        data-theme="light"
        data-container="bulkworksuite-reviews-widget"></script>

Tarjeta de producto

Tarjeta de producto pública única.

Guion

https://bulkworksuite.com/widgets/product-card.js

Example Embed

<script src="https://bulkworksuite.com/widgets/product-card.js"
        data-product-slug="bulkwork-suite-self-hosted-digital-business-platform"
        data-theme="light"
        data-container="bulkworksuite-product-card"></script>

Cuadrícula de productos

Cuadrícula de producto responsiva para una categoría o consulta de búsqueda.

Guion

https://bulkworksuite.com/widgets/product-grid.js

Example Embed

<script src="https://bulkworksuite.com/widgets/product-grid.js"
        data-category="digital-store"
        data-limit="6"
        data-theme="light"
        data-container="bulkworksuite-product-grid"></script>

Insignia de Calificación

Insignia compacta de resumen de valoración.

Guion

https://bulkworksuite.com/widgets/rating-badge.js

Example Embed

<script src="https://bulkworksuite.com/widgets/rating-badge.js"
        data-product-slug="bulkwork-suite-self-hosted-digital-business-platform"
        data-theme="light"
        data-container="bulkworksuite-rating-badge"></script>

Widget de preguntas frecuentes

Acordeón de preguntas frecuentes públicas sobre tiendas o productos.

Guion

https://bulkworksuite.com/widgets/faqs.js

Example Embed

<script src="https://bulkworksuite.com/widgets/faqs.js"
        data-product-slug="bulkwork-suite-self-hosted-digital-business-platform"
        data-limit="6"
        data-theme="light"
        data-container="bulkworksuite-faq-widget"></script>

Blog Posts

Latest published blog posts with title, featured image, excerpt, date, and read more link. Renders as a responsive card grid.

Guion

https://bulkworksuite.com/widgets/blog-posts.js

Example Embed

<script src="https://bulkworksuite.com/widgets/blog-posts.js"
        data-limit="6"
        data-theme="light"
        data-container="bulkworksuite-blog-posts"></script>

Forum Threads

Latest public forum threads with type badge, solved status, reply count, subforum name, and view link. Renders as a compact list.

Guion

https://bulkworksuite.com/widgets/forum-threads.js

Example Embed

<script src="https://bulkworksuite.com/widgets/forum-threads.js"
        data-limit="8"
        data-theme="light"
        data-container="bulkworksuite-forum-threads"></script>

Para las últimas reseñas de tiendas, omite data-product-slug. Añade data-producto-slug solo cuando quieras reseñas de un producto, y el widget aparecerá hasta el límite seleccionado.

Notas de seguridad

Esta API pública es intencionadamente de solo lectura y solo expone contenido público de catálogos.

Las cuentas de clientes, el pago, los pedidos, las descargas y la activación no forman parte de esta API pública. Utiliza las páginas de clientes de la tienda, el flujo de pago y el sistema de verificación de licencias para esos flujos de trabajo.

Las solicitudes están limitadas por IP. Mantén los widgets externos en caché siempre que sea posible y evita hacer sondeos demasiado agresivos.

OpenAPI para constructores

Utiliza el archivo OpenAPI para conectar herramientas que entienden esquemas API, generan clientes tipados o documentan endpoints automáticamente.

OpenAPI JSON