> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bold-factory.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introducción

> Conecta sistemas externos con Bold mediante la API, claves API y webhooks.

La API de Bold permite leer y actualizar datos operativos desde sistemas externos. Úsala para sincronizar catálogo, stock, pedidos, producción, compras, ventas y eventos con sistemas de gestión, herramientas de análisis, automatizaciones internas o herramientas propias.

<Info>
  La referencia completa se genera desde OpenAPI. Puedes consultarla en la sección [Referencia de API](/es/desarrolladores/referencia-api/introduccion) o abrirla en `https://api.bold-factory.com/docs`.
</Info>

## Qué puedes integrar

<Columns cols={2}>
  <Card title="Datos maestros" icon="boxes">
    Productos, artículos, propiedades, variantes y unidades.
  </Card>

  <Card title="Almacén" icon="warehouse">
    Ubicaciones, lotes, recepciones, envíos, inventarios y stock.
  </Card>

  <Card title="Planificación" icon="calendar-range">
    Demanda, suministro, stock proyectado, clientes y proveedores.
  </Card>

  <Card title="Producción" icon="factory">
    Recetas, versiones, órdenes, operaciones, recursos y ejecución.
  </Card>

  <Card title="Personas y permisos" icon="users">
    Usuarios, perfiles, empleados, jornadas, calendarios, turnos y tareas.
  </Card>

  <Card title="Mantenimiento" icon="wrench">
    Activos, acciones, causas, partes de trabajo, tiempos, materiales y preventivos.
  </Card>

  <Card title="Compras y ventas" icon="shopping-cart">
    Pedidos de compra, pedidos de venta, recepciones, envíos y líneas.
  </Card>

  <Card title="Notificaciones" icon="bell">
    Eventos, suscripciones personales, bandeja de app y lectura de avisos.
  </Card>

  <Card title="Analítica" icon="chart-no-axes-combined">
    Informes Power BI integrados, credenciales de apertura, duplicación y creación de informes.
  </Card>

  <Card title="Etiquetas" icon="tag">
    Plantillas, elementos de diseño y generación de documentos PDF.
  </Card>
</Columns>

## Referencia exacta

La sección **Referencia de API** usa `https://api.bold-factory.com/openapi/v1.json` para generar rutas, parámetros, esquemas de petición y respuesta, modelos y pruebas interactivas.

<Card title="Abrir referencia externa" icon="external-link" href="https://api.bold-factory.com/docs">
  Usa la referencia publicada por Bold si quieres verla fuera de esta documentación.
</Card>

## Patrón base

Las rutas públicas usan versión en la URL:

```http theme={null}
GET /v1/items/products
GET /v1/warehouse/locations
GET /v1/planning/salesOrders
GET /v1/production/orders
```

Las respuestas y errores usan JSON. Los listados paginados devuelven una estructura común con `results`, `pageNumber`, `pageSize`, `totalPages` y `totalCount`.

## Flujo recomendado

<Steps>
  <Step title="Crea una clave API">
    Crea una clave desde **Panel de control > Acceso > Claves API**. Usa una clave distinta por integración para poder revocarla sin afectar otros sistemas.
  </Step>

  <Step title="Prueba lectura antes de escribir">
    Empieza con rutas `GET` para validar autenticación, organización, permisos y paginación.
  </Step>

  <Step title="Sincroniza identificadores">
    Guarda las referencias de Bold que devuelven las rutas. Evita depender solo de nombres visibles, porque los nombres pueden cambiar.
  </Step>

  <Step title="Activa webhooks">
    Usa webhooks para enterarte de cambios sin consultar la API en bucle.
  </Step>
</Steps>

## Convenciones

| Convención   | Uso                                                      |
| ------------ | -------------------------------------------------------- |
| `v1`         | Versión pública actual de la API.                        |
| `reference`  | Identificador funcional visible en varias entidades.     |
| `id`         | Identificador técnico de una entidad.                    |
| `pageNumber` | Número de página, empezando en `1`.                      |
| `pageSize`   | Tamaño de página. El máximo validado por Bold es `1000`. |

<Tip>
  Para integraciones críticas, combina webhooks con reconciliaciones periódicas paginadas. El webhook te avisa rápido y la reconciliación detecta cualquier evento perdido.
</Tip>