Skip to main content
La Buyer API de OpenWrench da a los operadores de instalaciones acceso programático a todo lo que hay del lado del comprador en la plataforma: crear y hacer seguimiento de órdenes de trabajo, gestionar activos y ubicaciones, revisar cotizaciones y facturas, monitorear el mantenimiento preventivo y consultar tu red de proveedores.

​
URL base

Todos los endpoints del comprador están bajo /v1/buyer/.

​
Autenticación

Cada solicitud debe llevar dos cabeceras: X-API-KEY (tu clave de API, emitida por contacto de comprador) y OW-KEY (el secreto compartido de OpenWrench emitido junto a ella). La clave delimita automáticamente cada solicitud a tu empresa: solo verás tus propios datos. Las solicitudes a las que les falte cualquiera de las cabeceras devuelven 401.
Para obtener una clave de API y un secreto compartido, contacta a support@useopenwrench.com. Usa GET /v1/buyer/me para inspeccionar la identidad (contacto, instalación, empresa) detrás de tu clave. Las claves no expiran por sí solas. Para rotar una, solicita a soporte un nuevo par clave/secreto compartido, despliega el nuevo par y luego pide a soporte que revoque el antiguo.
La sección Internal Teams API, más abajo en esta pestaña, usa una clave de API de partner distinta: tu clave de comprador no autenticará contra esos endpoints /v1/partners/. Consulta la introducción a la Internal Teams API para más detalles.

​
Límites de tasa

10 solicitudes por ventana de 20 segundos por clave. Al superarlo recibirás 429 Too Many Requests: espera al menos 20 segundos antes de reintentar y espacia los trabajos en segundo plano (como exportaciones paginadas completas) para que se mantengan por debajo del límite.

​
Mantener las órdenes de trabajo sincronizadas

Si tu integración replica las órdenes de trabajo en otro sistema (una herramienta de tickets, un ERP, un data warehouse), constrúyela sobre push, no sobre sondeo:
  1. Registra un endpoint de webhook. OpenWrench envía los eventos workorder.create, workorder.status_update y workorder.new_note a medida que ocurren.
  2. En cada evento, obtén esa única orden de trabajo con GET /v1/buyer/work_order/work_orders/{id}.
  3. Usa GET /v1/buyer/work_order/work_orders para consultas puntuales, la carga inicial única y la conciliación ocasional, con un filtro estrecho y una página pequeña.
No sondees el endpoint de listado según un cronograma para descubrir órdenes de trabajo nuevas o cambiadas. Es la lectura más costosa de la API, es lenta en cuentas grandes y compite con tu trabajo real por el límite de tasa. Consulta Órdenes de trabajo para los detalles.

​
Envoltura de respuesta

Respuestas de una sola entidad:
Las respuestas de listado añaden un count total:
Errores:
401 significa clave faltante o inválida; 400 cubre entrada inválida, filtros incorrectos y denegaciones de permisos; 429 es el límite de tasa.

​
Paginación y filtrado

Los endpoints de listado aceptan offset, limit (por defecto 10, máx. 25), sort_by y order (asc | desc). Los parámetros de consulta adicionales se tratan como filtros de campo: pasa un nombre de campo con un valor (separa varios valores por coma) para filtrar el conjunto de resultados. Cada página de referencia lista sus filtros más destacados.

​
Formatos de fecha

La mayoría de las marcas de tiempo son cadenas ISO 8601 con offset (por ejemplo 2026-08-14T13:05:22.000-07:00); algunos campos de marca de tiempo de base de datos se serializan como yyyy-MM-dd HH:mm:ss.S. Las fechas simples son yyyy-MM-dd. Cuando envíes fecha-hora, usa ISO 8601.

​
Guías detalladas

Las guías de esta pestaña recorren cada parte de la API en profundidad, con payloads, modelos de estado y patrones de integración:

Órdenes de trabajo

Crear, filtrar, reasignar, cerrar. Modelo de estados, notas y tipos de problema.

Webhooks

Eventos de creación de orden de trabajo, cambio de estado y nueva nota enviados a tu endpoint.

Llamadas de servicio

Evidencia de la visita: registros de trabajo, tiempo real trabajado y detalles del técnico.

Activos y ubicaciones

Ubicaciones, regiones, tipos de activos, modelos, medidores y seguimiento de refrigerante.

Facturas

El flujo de aprobación, sincronización con AP, exportaciones aplanadas y actualizaciones masivas.

Cotizaciones y propuestas

Lee las cotizaciones del proveedor y concílialas con las facturas.

Mantenimiento preventivo

Lee cronogramas, omite ejecuciones y controla el PM desde un planificador externo.

Red de proveedores

Consulta tu red y prioriza a los proveedores de red privada para el despacho.

Encuestas de sitio

Recorridos y las órdenes de trabajo que salen de sus hallazgos.

Archivos y adjuntos

Sube una vez, referencia en todas partes, descarga la evidencia.

Cuenta y utilidades

Ping, identidad de la clave, aprovisionamiento de usuarios y tipos de cambio.