API para desarrolladores

Compilar con la API de la tienda

Utiliza endpoints JSON limpios para leer productos públicos, categorías, preguntas frecuentes y almacenar metadatos de aplicaciones, widgets, asistentes e integraciones.

OpenAPI JSON Guía de integración

Base URL

https://bulkworksuite.com/api/v1

Autenticación

Solo lectura pública

Formato

JSON - Solo GET

Inicio rápido

Llama a los endpoints con GET y lee la respuesta JSON. Los datos publicados del catálogo son públicos. Aquí no se exponen los datos de clientes privados, pedidos y descargas.

fetch('https://bulkworksuite.com/api/v1/products?per_page=6&category=digital-store')
  .then((r) => r.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"]:
    print(data["data"])

Puntos finales

GET /api/v1

Estado de la API

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

GET /api/v1/store

Metadatos de almacenamiento

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

GET /api/v1/products

Productos

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

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

GET /api/v1/product

Producto único

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

slug id

GET /api/v1/categories

Categorías

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

GET /api/v1/faqs

Preguntas frecuentes sobre tiendas

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

product_id product_slug type limit

GET /api/v1/reviews

Reseñas

Solo devoluciones aprobadas por reseñas públicas.

product_id product_slug rating min_rating page per_page limit sort

GET /api/v1/releases

Lanzamientos

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

product_id product_slug limit page per_page

GET /api/v1/blog

Blog Posts

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

page per_page q slug

GET /api/v1/forum

Forum Threads

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.

page per_page slug subforum category type solved q

GET /api/v1/search

Búsqueda

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

q type page per_page

GET /api/v1/widgets

Widgets

Devolve widgets incrustables disponibles y ejemplos de scripts seguros.

GET /api/v1/openapi.json

OpenAPI

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

Product List Example

GET /api/v1/products?per_page=6&category=digital-store

Use category, search, type, status, sort, page, and per_page to build external catalog screens.

Product Detail Example

GET /api/v1/product?slug=bulkwork-suite-self-hosted-digital-business-platform

Product detail includes public URLs, gallery images, description text, active FAQs, rating summary, and latest release metadata without exposing private download paths.

Ejemplo de reseñas

GET /api/v1/reviews?limit=6

Las reseñas públicas aprobadas incluyen nombres visuales y banderas de compra verificadas sin exponer los correos electrónicos de los clientes ni datos de pedidos.

Ejemplo de entradas de blog

GET /api/v1/blog
GET /api/v1/blog?slug=your-post-slug

Listas de entradas publicadas en el blog. Pass ?slug= para una sola publicación con contenido HTML completo.

Widgets incrustables

<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>

Utiliza el creador de widgets en administración para generar tarjetas de producto, cuadrículas, insignias de valoración, preguntas frecuentes y widgets de reseña.

Límites de velocidad y almacenamiento en caché

Las solicitudes están limitadas por IP. Cuando se supera el límite, la API devuelve una respuesta 429 con un error JSON consistente.

Las respuestas incluyen cabeceras Cache-Control. Almacena en caché las respuestas públicas de productos y widgets en tu app para reducir el tráfico y mantenerte dentro de los límites.

HTTP/1.1 429 Too Many Requests
X-RateLimit-Limit: 120
X-RateLimit-Window: 60

{
  "success": false,
  "error": {
    "code": "rate_limited",
    "message": "Too many requests."
  }
}