Integration Services 2014

Transcription

1 Integration Services 2014 Raitis Grinbergs and Dan Wyand EPiServer Commerce Development The Choice for Leaders in Digital

2 Current Integration PIM DAM Catalog XML Media CMS Media Commerce

3 Goals Improve support for integrations: Automatable Incremental as well as Bulk More types of data More extensible Backwards compatible Representational State Transfer (REST) Model

4 REST APIs for Integration.NET APIs should map to REST APIs easily REST means nouns more than verbs GET, POST, DELETE, PUT, PATCH are our verbs APIs are defined by things we GET, POST, DELETE, PUT, and PATCH

5 New Architecture CMS PIM DAM Catalog XML RESTful Calls Media EPiServer Integra9on Service Media Media Commerce

6 Technology EPiServer.Integration Web API v2.1 OAuth 2.0 authentication Microsoft.Owin.Security.OAuth implementation.net BackgroundTaskManager introduced in 7.7.2

7 New Import Functionality Removing Catalog Data Catalog <-> Media Asset Links Media Assets Meta data Linked to EPiServer.Core.MediaData

8 External ID Synchronization namespace EPiServer.Commerce.Catalog.ContentTypes { /// <summary> /// Indicates that a content type has a stable ID for integration with external systems. This is a temporary /// feature that is expected to be superseded by similar functionality in the EPiServer core. /// </summary> public interface IIntegratedContent { string IntegrationId { get; set; } } } Temporary solution for Alpha release EPiServer.Core.MediaContent derived classes need to implement IIntegratedContent Allows access to External ID from within CMS

9 Import Process Flow Client Integra9on Service Background Task Manager Authen9cate Request Token Store Token Check Creden9als Issue Token Import Send Document with Token Parse Upload & Submit Job Queue Job Store Job ID Return Job ID Return Job ID Track Request Status w/token & Job ID Request Job Status Return Job Status Return Job Status

10 Infrastructure and Bulk Uploads Ac9on HTTP Method URI Returns Request Version GET /episerverapi/version Version number Authen9cate and get security token POST /episerverapi/token Security Token for use in successive calls Upload & import Catalog Import XML (ZIP) file Upload & import EPISERVERDATA file Upload & import Catalog <- > Assets Linking XML file Upload & import Media Assets (ZIP) file Get current status on prior import job Get full log of prior import job messages POST /episerverapi/commerce/import/ catalog Task ID (GUID) for use in status requests POST /episerverapi/commerce/import/cms Task ID (GUID) for use in status requests POST /episerverapi/commerce/import/links Task ID (GUID) for use in status requests POST GET GET /episerverapi/commerce/import/assets Task ID (GUID) for use in status requests /episerverapi/commerce/task/ {taskid:guid}/status /episerverapi/commerce/task/ {taskid:guid}/log Latest status record for import task with given Task ID Full history of status records (to current point) for import task with given Task ID

11 Sample REST Process Flow Client Integra9on Service Authen9cate Request Token Store Token Check Creden9als Issue Token Manipulate GET Catalog Item with Token Determine Necessary Changes PUT Changed XML or DELETE Translate Request into Catalog API Return XML object Translate Request into Catalog API

12 Sample Catalog Entry Routes Ac9on Manipulate a Single Catalog Entry Get Paged Results for Catalog Entries HTTP Method URI GET, PUT, DELETE GET /episerverapi/commerce/entries/ {code:string} /episerverapi/commerce/entries/ {pagenumber:int}/{pagesize:int} Get Associa9ons for a Catalog Entry GET entries/{code}/associa9ons Manipulate an Associa9on for a Catalog Entry Manipulate an Asset linked to a Catalog Entry GET, PUT, DELETE GET, PUT, DELETE entries/{code}/associa9ons/ {associa9onname:string} entries/{code}/assets/{assetkey:guid}/ {assettype:string} Returns GET: Data structure for Catalog Entry PUT, DELETE: n/a Structure with list of Entry records, and Total Entry Count & Page Count List of Associa9ons for the requested Catalog Entry GET: Data structure for Associa9on PUT, DELETE: n/a GET: Data structure for Entry Asset Link PUT, DELETE: n/a and about 25 more and growing.

13 Catalog Entry Structure Most properties for related data do not contain the actual data Related data properties are URLs to the specific data Control the related data by traversing the list and manipulating the links

14 Initial Release Targets Catalog XML bulk import Media Assets bulk import Linking Commerce items to Media assets Commerce CRUDs Media CRUDs Documentation Improved installation experience