Sincronización de datos (data syncs)

El API REST de data syncs permite operar con los distintos tipos de sincronizaciones -importación, exportación y borrado de datos- para mantener la aplicación actualizada (de forma automática) con las fuentes de datos.

Autenticación

Todas las APIs de sincronización de datos pueden estar autenticadas si se desea. Esto se debe habilitar en cada data sync y generarse un token de autenticación que luego se utilizará en cada consumo de el API.

Cada pedido debe utilizar el encabezado de autenticación básica.

Debido a que un API token es específico para cada data sync, este se puede dar de baja sin afectar la operativa del resto.

Importación

Este endpoint permite interactuar con el API para realizar importación de clientes, datos de clientes por campaña, o prioridades para el modelo optimizado. En este último caso, las columnas del archivo a sincronizar deben ser las que están explícitas en la importación del modelo.

El dato DATASYNC_ID es un ID único de data sync que se obtiene de la consola de administración de Prisma Campaigns.

La información enviada es un multipart form-data que debe tener el siguiente parámetro:

El resultado está definido por uno de los siguientes códigos de estado HTTP:

Exportación

Este endpoint brinda la capacidad de interactuar con el API para descargar las exportaciones de clientes, desuscripciones, o resultados de campañas. Este API por defecto devolverá el último archivo generado de forma exitosa.

El dato DATASYNC_ID es un ID único de data sync que se obtiene de la consola de administración de Prisma Campaigns.

El resultado está definido por uno de los siguientes códigos de estado HTTP:

Eliminación

El uso del API es exactamente igual al de importación.

Estado de data sync

Mediante el uso de este endpoint es posible obtener información sobre la última ejecución del data sync (de cualquier tipo, ya sea importación, exportación o eliminación).

El dato DATASYNC_ID es un ID único de data sync y lo debe obtener de la consola de administración de Prisma Campaigns.

El resultado está definido por uno de los siguientes códigos de estado HTTP:

La respuesta es un objeto EDN o JSON que incluye la siguiente información:

{
  :name "Datasync Name"
  :status "enabled"
  :latest-launch {
    :id XXXXXXXXXXXXX,
    :status "cancelled",
    :scheduled-time "2022-01-14T20:00:00",
    :status-message "Cancelled by user: admin@prismacampaigns.com"
  }
  :next-launch "2022-01-17T13:00:00"
}

{
  "name": "Datasync Name",
  "status": "enabled",
  "latest-launch": {
    "id": XXXXXXXXXXXXX,
    "status": "cancelled",
    "scheduled-time": "2022-01-14T20:00:00",
    "status-message": "Cancelled by user: admin@prismacampaigns.com"
  },
  "next-launch": "2022-01-17T13:00:00"
}

Esquema de la última ejecución (latest launch):

Nota: El servidor puede devolver un objeto del tipo EDN o JSON dependiendo del contenido de los encabezados Accept y Content-Type. Vale la pena aclarar que este último es obligatorio.

Últimas ejecuciones

Este endpoint devuelve la información sobre las últimas ejecuciones del data sync (de cualquier tipo, ya sea importación, exportación o eliminación).

El dato DATASYNC_ID es un ID único de data sync y lo debe obtener de la consola de administración de Prisma Campaigns.

El resultado está definido por uno de los siguientes códigos de estado HTTP:

La respuesta es un array de objetos EDN o JSON que incluye la siguiente información:

[{:id XXXXXXXXXXXXX
  :status "cancelled"
  :scheduled-time "2022-01-14T20:00:00"
  :status-message "Cancelled by user: admin@prismacampaigns.com"
  }

  {:id XXXXXXXXXXXXX
   :status "finished"
   :scheduled-time "2022-01-13T20:00:00"
   }
]

[{"id": XXXXXXXXXXXXX,
  "status": "cancelled",
  "scheduled-time": "2022-01-14T20:00:00",
  "status-message": "Cancelled by user: admin@prismacampaigns.com"
  },

  {"id": XXXXXXXXXXXXX,
   "status": "finished",
   "scheduled-time": "2022-01-13T20:00:00"
   }
]

Nota: El servidor puede devolver un objeto del tipo EDN o JSON dependiendo del contenido de los encabezados Accept y Content-Type. Vale la pena aclarar que este último es obligatorio.

Descarga de ejecuciones

Este endpoint hace posible posible descargar la ejecución en un archivo .csv, incluso de ejecuciones en el pasado (de cualquier tipo, ya sea importación, exportación o eliminación). Esta API es útil si uno de los procesos de sincronización falló y se quiere volver a importar los archivos o examinar la falla del archivo importado.

El dato DATASYNC_ID es un ID único de data sync y lo debe obtener de la consola de administración de Prisma Campaigns, mientras que LAUNCH_ID representa un ID único de la ejecución que se puede obtener mediante el API de latest-launches.

El resultado está definido por uno de los siguientes códigos de estado HTTP:

Artículos relacionados

• Exportar desuscripciones hacia un sistema externo
• Importar desuscripciones desde un sistema externo