Loading...
Area: Episerver Service API
Applies to versions: 1 and higher

Overview of Service API

Recommendations [hide]

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.

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.

Note: 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 file formats

  • 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 Catalog service.
  • EPISERVERDATA file. The format for data exported from the CMS. See CMS content import 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 Catalog asset linking service. 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. A newer format that supports the bulk upload of assets into your systems, see Media service.

Bulk operation - available calls

Action HTTP
Method
Package URI Header Returns
Authenticate and get security token   POST EPiServer.ServiceApi /episerverapi/token  Content-Type: application/x-www-form-urlencoded Security Token for use in successive calls
Upload & import Catalog Import XML (ZIP) file POST EPiServer.ServiceApi.Commerce /episerverapi/commerce/import/catalog Authorization: Bearer <<token>>
Content-Type: multipart/form-data
Task ID (GUID) for use in status requests
Upload & import EPISERVERDATA file POST EPiServer.ServiceApi /episerverapi/commerce/import/cms/site/ {siteName}/{hostname}/{culture=} Authorization: Bearer <<token>>
Content-Type: multipart/form-data
Task ID (GUID) for use in status requests
Upload & import Catalog <-> Assets Linking XML file POST EPiServer.ServiceApi.Commerce /episerverapi/commerce/import/links Authorization: Bearer <<token>>
Content-Type: multipart/form-data
Task ID (GUID) for use in status requests
Upload & import Media Assets (ZIP) file  POST EPiServer.ServiceApi /episerverapi/commerce/import/assets Authorization: Bearer <<token>>
Content-Type: multipart/form-data 
Task ID (GUID) for use in status requests
Get current status on prior import job GET EPiServer.ServiceApi /episerverapi/commerce/task/ {taskId:GUID}/status Authorization: Bearer <<token>> Latest status record for import task with given Task ID
Get full log of prior import job messages GET EPiServer.ServiceApi /episerverapi/commerce/task/ {taskId:GUID}/log Authorization: Bearer <<token>> Full history of status records (to current point) for import task with given Task ID
Do you find this information helpful? Please log in to provide feedback.

Last updated: Oct 20, 2016

Recommendations [hide]