Integration Guide

Crie Apps, Widgets e Assistentes

Um guia prático para usar a API pública com segurança em sites externos, painéis, ferramentas sem código, assistentes de IA e páginas de comparação de produtos.

Referência API OpenAPI JSON

URL base

https://bulkworksuite.com/api/v1

Descubra a API

Comece pelo endpoint de status para ler o nome da loja, URL base, links de documentação e endpoints disponíveis.

Construa uma Visualização de Catálogo

Use produtos e categorias juntos para construir grades de produtos, telas de busca, páginas de comparação ou widgets externos para vitrines.

Mantenha os Dados Privados privados privados

A API pública expõe apenas dados de catálogo. Downloads, contas de clientes, pedidos e propriedade da licença permanecem protegidos pelos sistemas existentes de clientes e licenças.

O que você pode construir

Use a API pública para integrações reais de catálogos sem precisar de dados privados de checkout, conta, pedido ou licença.

External Catalogs

Renderize grades de produtos, filtros de categoria, tabelas de comparação ou páginas de lojas parceiras a partir de dados públicos de catálogos.

Blocos de Revisão

Mostre avaliações aprovadas e crachás de avaliação nas páginas de destino sem expor e-mails de clientes ou registros de pedidos.

AI Assistants

Permita que os assistentes leiam informações públicas sobre o produto, perguntas frequentes, comunicados de imprensa e armazenem metadados, mantendo os dados privados da conta protegidos.

Widgets Incorporáveis

Use widgets JavaScript autônomos para cartões de produtos, grades de produtos, FAQs, avaliações e crachás de avaliação.

Sindicato de blogs

Incorpore posts de blog publicados em sites externos, newsletters ou feeds de conteúdo usando o endpoint /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.

Ferramentas sem código

Conecte-se ao Zapier, Make (Integromat) ou n8n usando os endpoints GET públicos — nenhuma autenticação é necessária.

Registro de alterações da versão

Exiba o histórico de versões e o registro de alterações públicos em seu site de documentação ou página do produto sem expor links de download privados.

Busca Unificada

Impulsionar a busca em todo o site entre produtos, categorias e posts de blog usando o endpoint /api/v1/search com ?q=.

Fluxo de Trabalho Recomendado

Chame o endpoint de status e armazene a URL base da API a partir da resposta.
Busque categorias para construir filtros e navegação.
Busque produtos com paginação e filtros para telas de listagem.
Exibir um único produto somente quando o usuário abrir a página de detalhes.

Example Requests

Mapa de Endpoint

Essas são as rotas públicas somente leitura disponíveis para sites, widgets, ferramentas sem código e assistentes.

GET Status da API

/api/v1

Retorna a identidade da loja, os endpoints habilitados e os links para a documentação da API.

Parâmetros

Não são necessários parâmetros de consulta.

GET Armazenar metadados

/api/v1/store

Retorna a identidade pública da loja, a marca, os links para redes sociais e a disponibilidade do widget.

Parâmetros

Não são necessários parâmetros de consulta.

GET Produtos

/api/v1/products

Listas de produtos publicados, em breve e em pré-venda com paginação e filtros.

Parâmetros

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

GET Produto único

/api/v1/product

Retorna um produto público pelo slug ou id, incluindo galeria, perguntas frequentes, metadados da versão mais recente e URLs públicas.

Parâmetros

slug id

GET Categorias

/api/v1/categories

Lista as categorias da loja pública com a quantidade de produtos e URLs amigáveis para cada categoria.

Parâmetros

Não são necessários parâmetros de consulta.

GET Perguntas frequentes da loja

/api/v1/faqs

Retorna as perguntas frequentes (FAQs) ativas da página inicial para construtores e assistentes externos.

Parâmetros

product_id product_slug type limit

GET Avaliações

/api/v1/reviews

Devoluções somente com base em avaliações públicas aprovadas.

Parâmetros

product_id product_slug rating min_rating page per_page limit sort

GET Lançamentos

/api/v1/releases

Retorna metadados públicos de lançamento e changelog sem os caminhos de download.

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 Procurar

/api/v1/search

Pesquisa produtos públicos, categorias e conteúdo de blogs públicos.

Parâmetros

q type page per_page

GET Widgets

/api/v1/widgets

Retorna widgets incorporáveis disponíveis e exemplos de scripts seguros.

Parâmetros

Não são necessários parâmetros de consulta.

GET OpenAPI

/api/v1/openapi.json

Descrição OpenAPI legível por máquina para a API pública.

Parâmetros

Não são necessários parâmetros de consulta.

Forma de Resposta ao Sucesso

Endpoints de lista retornam dados, paginação e metadados da API em um envelope 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:52+00:00"
    }
}

Formato da resposta de erro

Solicitações inválidas retornam um objeto de erro estável, sem rastreamento de pilha ou detalhes SQL.

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

Paginação e Filtros

Use página e per_page para telas de lista. A API limita grandes requisições, então as páginas externas permanecem rápidas e previsíveis.

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

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

Resenhas

Controle deslizante ou lista de avaliações aprovada para um produto.

Roteiro

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

Exemplo de incorporação

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

Cartão de produto

Cartão de produto público único.

Roteiro

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

Exemplo de incorporação

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

Grade de Produtos

Grade de produto responsivo para uma consulta de categoria ou busca.

Roteiro

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

Exemplo de incorporação

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

Distintivo de Classificação

Distintivo compacto de resumo de classificação.

Roteiro

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

Exemplo de incorporação

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

FAQ Widget

Frequentes públicas de FAQ acordeão para FAQs de lojas ou produtos.

Roteiro

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

Exemplo de incorporação

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

Roteiro

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

Exemplo de incorporação

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

Roteiro

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

Exemplo de incorporação

<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 Segurança

Esta API pública é intencionalmente de leitura e expõe apenas conteúdo público de catálogo.

Contas de clientes, checkout, pedidos, downloads e ativação não fazem parte desta API pública. Use as páginas dos clientes da loja, o fluxo de checkout e o sistema de verificação de licenças para esses fluxos de trabalho.

As requisições são limitadas por IP. Mantenha widgets externos em cache sempre que possível e evite fazer polling de forma muito agressiva.

OpenAPI para Construtores

Use o arquivo OpenAPI para conectar ferramentas que entendem esquemas de API, gerem clientes tipados ou documentem endpoints automaticamente.

OpenAPI JSON