Area:
The Episerver Service API is a service layer that allows system integrators to update and retrieve information from Episerver, ensuring a seamless integration with external systems, such as PIM, DAM and ERPs.
User scenarios
The Episerver Service API provides a programming interface for performing operations like:
- Bulk import and export of media in Commerce.
- Bulk import and export of catalog data in Commerce.
- Bulk asset linking between media and catalog content in Commerce.
- Import and export of "episerverdata" content type of files.
- Import and export of Forms data.
- RESTful CRUD operations for managing data integration with catalogs, orders, customers, and content.
Getting started
The Episerver Service API is installed as a NuGet package EPiServer.ServiceApi. The Service API is available for Episerver Commerce version 8.5 and higher. See Installation and configuration how to install and set up the integration.
How it works
The Service API integration service uses OWIN-based authentication and ASP.NET Identity, see Installation and configuration and Overview of Service API.
Requests and responses
Below is an example illustrating the usage of the REST API for managing CRUD operations.
GET carts by name and customer ID
/episerverapi/commerce/carts/{customerId}/{name}
- Base path (base URL/host): episerverapi
- Endpoint: commerce/carts/
- Query string parameter(s): /{customerId}/{name}
Example: Request GET method using C#/.NET
var client = new HttpClient()
{
BaseAddress = new Uri(ConfigurationManager.AppSettings["integrationUrl"])
};
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token.AccessToken);
var result = client.GetAsync("/episerverapi/commerce/carts/{customerId}/{name}").Result.Content.ReadAsStringAsync().ResultJSON response
Overview of request and response interactions between the application and the REST API.
Related topics
Last updated: Apr 14, 2021
