Hide menu Last updated: Oct 20 2016
Area: Episerver Service API Applies to versions: 1 and higher

Overview of Service API

This topic provides an overview of available calls in the Episerver Service API. The calls and their formats are described in detail, together with the integration service work process and supported bulk files.

Bulk operation available calls

Work process

The general process of working with the integration service is as follows:

  1. Authenticate with a call to /episerverapi/token, capturing the returned token.
  2. Import with a call to /episerverapi/commerce/import/{import_type}, passing along the authentication token and capturing the returned job ID.
  3. Check on the import status with a call to /episerverapi/commerce/task/{job_id}/status.

The task manager backing this runs the imports sequentially, but multiple jobs can be queued. The queue is held entirely in memory, so an IIS restart wipes out the pending tasks (and breaks the running import).

Supported bulk files

  • Catalog Import XML (provided in the compressed ZIP format). The older format for manual catalog imports. It was extended to include a section for importing links between existing assets and catalog nodes and entries (but not for adding new assets). See Using the catalog service.
  • EPISERVERDATA file. The format for data exported from the CMS. See Using the CMS service. The file format is undocumented and there is no guarantee of backwards compatibility.
  • Asset Linking XML file. A newer format that supports the linking of catalog nodes/entries and assets. See Using the catalog asset linking service for information about this file format. You can include these data in the Catalog Import XML file, but for convenience, there is a separate action to improve testability.
  • Media Assets ZIP file. Also a newer format that supports the bulk upload of assets into your systems. See Using the catalog asset linking service for information about this file format.