Brightmarket Sync Guide

Versiones y cambios para clientes

Compará versiones del SDK, revisá qué debe implementar el cliente y descargá templates históricos.

Usá esta página antes de actualizar el pin brightmarket-data-sync==X.Y.Z en un proyecto cliente.

El changelog está curado para priorizar el impacto del lado cliente: cambios de contrato, writers nuevos, payloads, template, CLI y documentación que conviene revisar.

Comparar versiones

Seleccioná una versión inicial y una final. El resultado muestra todas las versiones del rango y pone primero las acciones que debe revisar el cliente.

El rango muestra las versiones posteriores a la versión inicial e incluye la versión final seleccionada.

SDK 1.2.0

v1.2.02026-06-14

Agrega escritura de movimientos de puntos y actualización de puntos activos para clientes.

Qué tiene que hacer el cliente

  • Actualizar el pin del cliente a `brightmarket-data-sync==1.2.0` cuando se adopte esta versión.
  • Si usás el template nuevo, implementar `get_points_movements` y ejecutar `python -m src.main -points_movements` cuando aplique.
  • Si el cliente necesita enviar movimientos de puntos, leer esos movimientos desde la fuente del cliente y mapearlos a `client_external_id`, `movement_type`, `points_moved`, `expiration_date` y `comments`.
  • Llamar `create_points_movement(..., api=api)` desde el script de sync del cliente para sumar, restar o registrar movimientos según el tipo que use Brightmarket.
  • Si el cliente solo necesita corregir el saldo actual, llamar `set_client_active_points(..., api=api)` con los puntos activos y pendientes si corresponde.
  • Mantener la lógica de lectura y reglas de negocio de puntos dentro del repo cliente; el SDK solo escribe el payload ya transformado.

Cambios del SDK

  • Nuevo writer público `create_points_movement(client_external_id, movement_type, points_moved, expiration_date=None, comments=None)` para crear movimientos de puntos sobre un cliente por external ID.
  • Nuevo helper `set_client_active_points(client_external_id, active_points, pending_points=None)` para fijar puntos activos y opcionalmente pendientes de un cliente.
  • El contrato `BrightmarketAdapter` ahora incluye `get_points_movements(from_date=None, to_date=None)` para que los clientes expongan movimientos de puntos desde su fuente.
  • `create_points_movement` y `set_client_active_points` se exportan desde `brightmarket_data_sync.writers` para que el cliente no implemente llamadas HTTP propias.
  • Los movimientos de puntos usan el endpoint de cliente `clients/external/{client_external_id}/points/addPointsMovement` con `type`, `pointsMoved`, `comments` y `expirationDate`.

Descargar templates por versión

Cada ZIP se genera desde el template cliente y queda pinneado a la versión del SDK indicada en su requirements.txt.

On this page