Recursos · Desarrolladores

REST API Referencia

71 puntos finales en recursos 19. SocialHub v2 REST API te permite administrar tiendas, miembros de fidelidad, puntos, cupones, capturas, el programa Ambassador y seguimiento. Todos los puntos finales requieren Authorization: Bearer fl_live_… a menos que se indique lo contrario.

URL basehttps://flash.socialhub.ai/api/v2

OpenAPI JSON Ejecutar desde Claude (SoCode)

Esta referencia refleja la API en vivo. Es una instantánea estática del catálogo de puntos finales, agrupada por recurso. Para el contrato siempre actualizado y legible por máquina (parámetros, cuerpos de solicitud, esquemas de respuesta), consulte OpenAPI JSON →

Autenticación

Autenticarse con una clave de portador

Cada solicitud se autentica con una clave API de SocialHub (fl_live_…) enviada como token de portador. Las claves están asociadas a tu equipo y a cada herramienta; créalas y adminístralas en tu cuenta de SocialHub.

curl https://flash.socialhub.ai/api/v2/members \
  -H "Authorization: Bearer fl_live_your_key_here"

¿Prefieres mantener la clave en texto plano fuera del historial de tu shell? Exporta la clave como FLASH_API_KEY y haz referencia a la variable de entorno.

Modo de prueba (sandbox)

Marca una clave como clave de prueba para compilarla en un entorno de pruebas en la misma URL base, sin necesidad de un entorno o credenciales independientes. Los datos generados con ella (miembros, pedidos, cupones) se etiquetan y ocultan de tus listas y paneles de control reales; un miembro de prueba nunca recibe ningún contacto real (se suprimen los correos electrónicos, SMS y notificaciones push de marketing) y un cupón de prueba nunca se canjea por valor real; y un solo POST /api/v2/test-data/purge borra todo. Experimenta libremente y luego reinicia.

Gestionar claves API

Referencia

Puntos finales

71 puntos finales en los grupos de recursos 19. Método, ruta y un resumen de una línea para cada uno; los detalles completos de los parámetros y el esquema se encuentran en el JSON OpenAPI.

CWM Pronósticos

4 punto finals

CWMdistribución del próximo evento final único de TimesFM 2.5 pronósticos de demanda y ventanas de fusión privadas para inquilinos. Los comportamientos siguientes requieren predictions:read; tendencias/ventanas también requieren metrics:readLas probabilidades del próximo evento no están calibradas y dependen de objetivos compatibles; las ventanas de fusión permanecen null hasta que esté entrenado y validado.

GET/api/v2/cwm/capabilitiesLea la disponibilidad de tendencias/cuantiles y la preparación de fusión de inquilinos 7/30/90d (predictions:read)

GET/api/v2/cwm/members/{id}/next-behaviorsRespuesta de un miembro con distribución/clasificación del próximo evento y automática CWM + TimesFM 7/30/90d purchaseWindowsProbabilidades de eventos sin calibrar; ventanas de compra null hasta que esté entrenado/validado (predictions:read; metrics:read Además habilita Windows)

GET/api/v2/cwm/trendsPrevisión de métricas diarias de marca/categoría: punto + no calibrado q10..q90; los días faltantes no están disponibles

GET/api/v2/cwm/members/{id}/purchase-windowsProbabilidades de compra (0-1) para usuarios privados (7/30/90 días), null hasta su entrenamiento y validación

Tiendas

4 punto finals

Gestión de tienda

GET/api/v2/storesLista de tiendas (filtrar por externalId / updatedSince)

GET/api/v2/stores/{id}Obtener tienda por ID

POST/api/v2/storesCrear o actualizar una tienda (por externalId)

PUT/api/v2/stores/{id}Actualizar una tienda

Miembros

12 punto finals

Gestión de miembros del programa de fidelización

GET/api/v2/membersLista / buscar miembros (correo electrónico, externalId, updatedSince)

POST/api/v2/membersCrear o insertar o actualizar un miembro (por externalId / correo electrónico)

POST/api/v2/members/batchCreación/actualización masiva de miembros (≤100, 207)

GET/api/v2/members/{id}Obtener miembro por ID

PARCHE/api/v2/members/{id}Actualización del perfil/identidad de un miembro

GET/api/v2/members/{id}/pointsConsulta el saldo de puntos de miembro

POST/api/v2/members/{id}/pointsGana/canjea/revierte puntos

GET/api/v2/members/{id}/tierObtener el nivel de membresía

GET/api/v2/members/{id}/couponsObtenga cupones de miembro

GET/api/v2/members/{id}/receiptsObtén recibos de miembros

GET/api/v2/members/{id}/profileObtenga el perfil agregado de un miembro: accesibilidad, consentimiento/CCPA, lealtad, resúmenes de comercio/participación + campos predictivos (fecha prevista del próximo pedido, propensión a hacer clic en el correo electrónico; nulo debajo de las puertas de datos), preferencias, etiquetas (solo lectura, PII redactada)

POST/api/v2/members/{id}/redeem-couponCanjea puntos por un cupón

Pedidos

4 punto finals

Ingesta de pedidos → puntos, reembolsos y conciliación automáticos

GET/api/v2/ordersListar pedidos ingeridos (filtrar por miembro / externalId / updatedSince)

POST/api/v2/ordersIngresa un pedido y otorga puntos automáticamente

POST/api/v2/orders/batchIngesta de pedidos al por mayor (≤100, 207)

POST/api/v2/orders/{externalOrderId}/refundReembolso de un pedido (recuperación proporcional de puntos)

Catálogo

5 punto finals

Catálogo de productos (PIM): productos, variantes, categorías, marcas; Importación genérica de ERP/Shopify

GET/api/v2/productsLista de productos (filtrar por estado / categoría / marca / sector)

GET/api/v2/products/{id}Obtenga un producto con variantes, medios y contenido

GET/api/v2/categoriesListar categorías de productos

GET/api/v2/brandsLista de marcas

POST/api/v2/catalog/importUpsert genérico — marcas/categorías/productos/variantes/inventario por external_id

Etiquetas de miembros

4 punto finals

Lea el catálogo de etiquetas (ciclo de vida, RFM, nivel de valor, participación, momento de compra, preferencia (incluida la afinidad de categoría), riesgo, consentimiento y ejes de canal) y asigne o elimine manualmente las etiquetas de un miembro.

GET/api/v2/tagsDefiniciones de etiquetas de lista (ejes basados en reglas + etiquetas de estado boolean)

GET/api/v2/members/{id}/tagsListar las etiquetas de un miembro

POST/api/v2/members/{id}/tagsAsignar una etiqueta a un miembro (por tagKey)

ELIMINAR/api/v2/members/{id}/tags/{tagKey}Eliminar la etiqueta de un miembro

Campos personalizados

2 punto finals

Lee los campos personalizados definidos por el inquilino para cualquier entidad (miembro, tienda, producto, grupo de cupones, pedido). Solo lectura; no contiene información personal identificable (PII) por diseño. Ámbito: custom_fields:read.

GET/api/v2/custom-fieldsLista de definiciones de campos personalizados para una entidad (?entity=member|store|product|coupon_pool|order)

GET/api/v2/custom-fields/valuesObtenga los valores de los campos personalizados de un registro (?entity=…&entityId=…)

Capturas

1 punto final

Capturar registros

GET/api/v2/capturesCapturas de lista

Cupones

4 punto finals

Grupos de cupones, códigos y canje

GET/api/v2/couponsLista de cupones

GET/api/v2/coupons/poolsLista de cupones

POST/api/v2/coupons/issueEmitir un cupón

POST/api/v2/coupons/{id}/redeemCanjear un cupón

Embajador

3 punto finals

Programa de embajadores: candidatos, informe de ROI y códigos de afiliado

GET/api/v2/ambassador/candidatesLista de candidatos a Embajador

GET/api/v2/ambassador/metricsObtener informe de ROI de Embajador

POST/api/v2/ambassador/members/{id}/issue-codeEmitir un código de afiliado Embajador

Seguimiento

2 punto finals

Análisis de visitas a páginas/comportamiento e ingesta de eventos

GET/api/v2/tracking/statsObtenga análisis de comportamiento y visitas a la página

POST/api/v2/tracking/eventsRegistrar un evento de visualización de página/seguimiento

API Claves

3 punto finals

API Gestión de claves

GET/api/v2/api-keysListar claves API

POST/api/v2/api-keysCrear clave API

ELIMINAR/api/v2/api-keys/{id}Eliminar la tecla API

autenticación

7 punto finals

Autenticación y perfil de usuario

POST/api/v2/auth/registerRegistro

POST/api/v2/auth/loginInicio de sesión

GET/api/v2/auth/profileObtener perfil

PARCHE/api/v2/auth/profileActualizar perfil

POST/api/v2/auth/change-passwordCambiar contraseña

POST/api/v2/auth/forgot-password¿Olvidaste tu contraseña?

POST/api/v2/auth/reset-passwordRestablecer contraseña

Segmentos

5 punto finals

Segmentos de audiencia: condiciones estructuradas utilizadas para la segmentación de campañas

GET/api/v2/segmentsListar segmentos de audiencia

POST/api/v2/segmentsCree un segmento a partir de condiciones estructuradas (no SQL).

GET/api/v2/segments/{id}Obtener un segmento

PARCHE/api/v2/segments/{id}Actualizar un segmento

ELIMINAR/api/v2/segments/{id}Archivar un segmento (software)

Campañas

3 punto finals

Campañas: lista y crea borradores (nunca se envían; un humano los revisa y los envía).

GET/api/v2/campaignsLista de campañas.

POST/api/v2/campaignsCrear un BORRADOR de campaña (nunca se envía; desde una plantilla/fuente)

GET/api/v2/campaigns/{id}Crea una campaña

Automatizaciones

2 punto finals

Automatizaciones: enumerar flujos activados por eventos y pausarlos/reanudarlos

GET/api/v2/automationsAutomatizaciones de lista y su estado

PARCHE/api/v2/automations/{id}Pausar o reanudar una automatización

Transaccional

1 punto final

Envío transaccional: su sistema activa un envío a un único destinatario de una campaña que un humano habilitó explícitamente para uso transaccional (confirmaciones de pedidos, recibos). API nunca crea contenido; la supresión de entregabilidad siempre se respeta; pasar idempotency_key para que los reintentos sean seguros

POST/api/v2/transactional/sendEnviar una campaña habilitada a un destinatario con datos combinados

Importaciones

4 punto finals

Importación masiva asíncrona: cargue un archivo CSV/JSONL de miembros/pedidos y consulte el estado del trabajo (sin límite de 100 filas).

POST/api/v2/members/importImportación asíncrona de miembros (CSV/JSONL)

GET/api/v2/members/import/{id}Consulta el estado/progreso de una tarea de importación de miembros

POST/api/v2/orders/importImportación de pedidos asíncronos en cola (CSV/JSONL)

GET/api/v2/orders/import/{id}Consulta el estado y el progreso de la importación de pedidos

Datos de prueba

1 punto final

Datos del modo de prueba de Sandbox: se elimina todo lo que haya creado una clave de prueba.

POST/api/v2/test-data/purgeEliminar por completo todos los datos del modo de prueba del equipo

Envío reciente

Campos de perfil predictivos y recomendaciones más inteligentes

Dos actualizaciones aterrizan dentro de los puntos finales existentes: no hay una nueva superficie pública y las formas de respuesta de los puntos finales de recomendación existentes no cambian.

GET /api/v2/members/{id}/profile

Los resúmenes de perfiles ahora incluyen campos predictivos, que se calculan cuando los datos del equipo admiten un ajuste:

Fecha prevista del próximo pedido: un ajuste Gamma por miembro sobre los intervalos de compra del propio miembro (requiere ≥ 3 compras), que devuelve las estadísticas del intervalo y un indicador de confianza.
Propensión a clics en correos electrónicos: una logística regularizada L2 por equipo P(click) a partir de las funciones de interacción agregadas del perfil.

Ambos campos están null debajo de las puertas de la honestidad: nunca se puede adivinar. Los consumidores deben manejar valores nulos.

Recommendations (public embed + v2)

La puntuación de compra conjunta se actualiza a (similitud entre artículos normalizada por coseno ), por lo que la fuerza de la combinación ya no está dominada por los artículos más vendidos:

score = co_count / sqrt(buyers(A) × buyers(B))   # pairs need ≥2 shared buyers
                                                 # raw co_count still stored

Una nueva tarea nocturna de minería de reglas de asociación se ejecuta por equipo (soporte/confianza/mejora; MIN_PAIR_ORDERS=3, MIN_CONFIDENCE=0.05, las 25 reglas principales por antecedente según la mejora) y proporciona sugerencias de venta cruzada. Las integraciones existentes siguen funcionando tal cual; las formas de respuesta no cambian.

OpenAPI JSON (legible por máquina)Ejecutar desde Claude (SoCode)Gestionar claves API Volver a Recursos