PI para desenvolvedores

Crie com a API da Loja

Use endpoints JSON limpos para ler produtos públicos, categorias, perguntas frequentes e armazenar metadados de aplicativos, widgets, assistentes e integrações.

OpenAPI JSON Guia de integração

URL base

https://bulkworksuite.com/api/v1

Autenticação

Público somente para leitura

Formatar

JSON — somente GET

Início rápido

Acesse os endpoints com o método GET e leia a resposta JSON. Os dados do catálogo publicado são públicos. Dados privados de clientes, pedidos e downloads não são expostos aqui.

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"])

Endpoints

GET /api/v1

Status da API

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

GET /api/v1/store

Armazenar metadados

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

GET /api/v1/products

Produtos

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

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

GET /api/v1/product

Produto único

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

slug id

GET /api/v1/categories

Categorias

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

GET /api/v1/faqs

Perguntas frequentes da loja

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

product_id product_slug type limit

GET /api/v1/reviews

Avaliações

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

product_id product_slug rating min_rating page per_page limit sort

GET /api/v1/releases

Lançamentos

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

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

Procurar

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

q type page per_page

GET /api/v1/widgets

Widgets

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

GET /api/v1/openapi.json

OpenAPI

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

Exemplo de lista de produtos

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

Utilize categoria, pesquisa, tipo, status, classificação, página e por página para construir telas de catálogo externas.

Exemplo de detalhes do produto

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

Os detalhes do produto incluem URLs públicas, imagens da galeria, texto descritivo, perguntas frequentes ativas, resumo da avaliação e metadados da versão mais recente, sem expor caminhos de download privados.

Exemplo de avaliação

GET /api/v1/reviews?limit=6

As avaliações públicas aprovadas incluem nomes de exibição e sinalizadores de compra verificada, sem expor e-mails de clientes ou dados de pedidos.

Exemplo de postagem de blog

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

Lista as postagens de blog publicadas. Use ?slug= para obter uma postagem individual com todo o conteúdo HTML.

Widgets incorporáveis

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

Utilize o construtor de widgets no painel de administração para gerar fichas de produtos, tabelas, selos de classificação, perguntas frequentes e widgets de avaliação.

Limites de taxa e armazenamento em cache

O número de requisições é limitado por endereço IP. Quando esse limite é excedido, a API retorna uma resposta 429 com um erro JSON consistente.

As respostas incluem cabeçalhos Cache-Control. Armazene em cache as respostas públicas de produtos e widgets em seu aplicativo para reduzir o tráfego e permanecer dentro dos limites.

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