Import Export API

Overview

Vynamic Engage Import Service enables the bulk import of data concerning Customers from an external system, using .csv files containing data to be imported. The feature is usually used when a given retailer wants to switch from the old system to Vynamic Engage, and enables them to move the data of their customers from the old system to Vynamic Engage. It concerns, for instance, the following data: Individual Person, Organization, Households, Devices, Postal Address, Email Address, Telephone, Consents, Loyalty data including accounts and cards.

Import_service_Architecture.PNG

Features

The Import Export API provides the following use cases:

  • Create a new bulk import job.
  • Upload a bulk import job package.
  • Start a created import job.
  • Cancel an existing bulk import job.
  • Retrieve a current status and details of a given bulk import job, based on a job identifier.
  • Retrieve bulk import jobs list and current statuses, based on certain criteria.
  • Enable cancellation of an existing report job.
  • Retrieve a report jobs list and current statuses based on certain criteria.
  • Enable the creation of a new report job.
  • Retrieve a current status and details of a given report job based on a job identifier.
  • Retrieve a report job data based on a job identifier.

Health Check: The GET /healthCheck endpoint allows the API client to check the status of the dependent backend service. On the 200 response, the client receives the overall status information: healthy, degraded, unhealthy.

Security

The Import Export API supports OAuth 2.0 for authentication purposes.
The supported protocol for the Import Export API is HTTPS.