Hide menu Last updated: Feb 13 2017
Area: Episerver Service API Applies to versions: 3 and higher
Other versions:

Installation and configuration - Service API

This section describes how to install and configure EPiServer.ServiceApi as the integration service with OWIN-based authentication and ASP.NET Identity. 

Prerequisites

  • Microsoft .NET Framework 4.5.2. You can download the framework from Microsoft.

Installing NuGet packages

Install Episerver updates through the NuGet Package Manager in Visual Studio. See Installing Episerver updates for information.

Installing the Service API components

To set up the service layer and related components:

  1. Install the .NET Framework 4.5.2 Developer pack
  2. Open Visual Studio 2012 or higher (earlier versions do not support .NET 4.5.2).
  3. Open your Episerver-based solution (either the Commerce sample website or your actual solution), right-click the relevant project, select Properties, and set the target framework to .NET Framework 4.5.2 or higher.
  4. Use the menu option Tools > Nuget Package Manager > "Manage Nuget packages for Solution..." (or right-click on the solution References and select there).
  5. Click Settings to create a source pointing to the Episerver NuGet feed.
  6. Open the Online section and select the source you just created.
  7. Install EPiServer.ServiceApi or EPiServer.ServiceApi.Commerce if working with Commerce, and all dependencies (including both Episerver and third party packages) Episerver-based solution (either the Commerce sample website or your actual solution). Do not install EPiServer.ServiceApi or EPiServer.ServiceApi.Commerce on your Commerce Manager site.
  8. Use the menu option Tools > NuGet Package Manager > Package Manage Console, and run the command update-epidatabase.
  9. Running update-epidatabase or Automatic schema updates sets administrator permissions automatically but you should check that these have been set correctly. Otherwise, set account permissions for administrators to execute the Service API in the database (tblUserPermission). (If not, an HTTP 401 status is returned.)

  10. Open EPiServerFramework.config and make sure that <appData> has a <basePath> directory that points to a valid location for which IIS has write permissions.

    Note: Monitor this folder over time because there is no built-in cleanup.

  11. Open IIS, Edit Bindings, and assign a custom HTTPS binding (HTTPS is required for the integration service).
  12. Open the website to verify that it works.

Configuring OWIN startup

Service API uses OWIN-based authentication. This needs to be configured in the application’s Startup class. The EPiServer.ServiceApi.Owin namespace contains the application builder extension methods required for this configuration. The following example sets up Service API to authenticate service calls using ASP.NET Membership:

using EPiServer.ServiceApi.Owin;
using Owin;

namespace EPiServer.ServiceApi.Sample
{
    public class Startup
    {
        public void Configuration(IAppBuilder app)
        {
            // Enable bearer token authentication using Membership for Service Api
            app.UseServiceApiMembershipTokenAuthorization();
        }        
    }
}

Service API can also be set up to authenticate service calls using ASP.NET Identity. How to set up ASP.NET Identity in general and to work with the EPiServer UI in particular, is described in EPiServer AspNetIdentity. The following example extends the EPiServer UI ASP.NET call to the UseServiceApiIdentityTokenAuthorization method to configure Service API to use the same user type:

using System;
using EPiServer.Cms.UI.AspNetIdentity;
using EPiServer.ServiceApi.Owin;
using Microsoft.AspNet.Identity;
using Microsoft.AspNet.Identity.Owin;
using Microsoft.Owin;
using Microsoft.Owin.Security.Cookies;
using Owin;

namespace EPiServer.ServiceApi.Sample
{
    public class Startup
    {
        public void Configuration(IAppBuilder app)
        {
            // Add CMS integration for ASP.NET Identity
            app.AddCmsAspNetIdentity<ApplicationUser>();

            // Use cookie authentication
            app.UseCookieAuthentication(new CookieAuthenticationOptions
            {
                AuthenticationType = DefaultAuthenticationTypes.ApplicationCookie,
                LoginPath = new PathString("/util/login.aspx"),
                Provider = new CookieAuthenticationProvider
                {
                    OnValidateIdentity = SecurityStampValidator.OnValidateIdentity<ApplicationUserManager<ApplicationUser>, ApplicationUser>(
                        validateInterval: TimeSpan.FromMinutes(30),
                        regenerateIdentity: (manager, user) => manager.GenerateUserIdentityAsync(user))
                }
            });

            // Enable bearer token authentication using ASP.NET Identity for Service Api
            app.UseServiceApiIdentityTokenAuthorization<ApplicationUserManager<ApplicationUser>, ApplicationUser>();
        }
}
Note: With ASP.NET Identity configured, you must also make sure you have a registered user account with the appropriate permissions (for example a member of the Administrators group), as described earlier in this article.

 

Configuration modifications

Some settings are configured in the OWIN startup and some are are configured in web.config.

Token Timeout in Minutes

This setting can be added to the OWIN startup configuration. If omitted, the authorization server is configured without setting the default OAuthAuthorizationServerOptions.AccessTokenExpireTimeSpan is used (20 minutes).

app.UseServiceApiMembershipTokenAuthorization(new ServiceApiTokenAuthorizationOptions
{
    AccessTokenExpireTimeSpan = TimeSpan.FromMinutes(60)
});

 File Upload Maximum Size

To increase the maximum size that can be uploaded, change maxAllowedContentLength. Currently, the maximum file size that can be uploaded is 2 GB.

Note: maxAllowedContentLength is in bytes, while maxRequestLength is in kilobytes.

<system.webServer>
         <security>
		<requestFiltering>
			<requestLimits maxAllowedContentLength="524288000" />
		</requestFiltering>
	</security>
</system.webServer>
<system.web>
    <httpRuntime requestValidationMode="2.0" maxRequestLength="102400" />
</system.web>

Disable Attribute Routing

XMLService API automatically enables attributes routing. 
If you already configured this, you can disable the Service API from automatically enabling attributes by adding an app setting.
For information, see Attribute Routing in ASP.NET Web API 2.

<appsettings>
	<add key="episerver:serviceapi:maphttpattributeroutes" value="false" />
</appsettings>

Disable SSL requirement for request

By default, Service API requires secure connections both for authentication and for API calls. This can be disabled using an app setting, e.g. for a debug configuration in development.

<appsettings>
	<add key="episerver:serviceapi:requiressl" value="false" />
</appsettings>
 Note: Live sites should not disable SSL.

 

Authentication tokens

To use any EPiServer.ServiceApi RESTful method, you must obtain an "OAuth 2 Bearer Token" to send with the request.

Example: Request

using (var client = new HttpClient())
{
	client.BaseAddress = new Uri("https://mysite.com/");
	var fields = new Dictionary<string, string>
	{
		{ "grant_type", "password" },
		{ "username", username },
		{ "password", password }
	};
	var response = client.PostAsync("/episerverapi/token", new FormUrlEncodedContent(fields)).Result;
	if (response.StatusCode == HttpStatusCode.OK)
	{
		var content = response.Content.ReadAsStringAsync().Result;
		var token = JObject.Parse(content).GetValue("access_token");
	}
}			

POST /episerverapi/token HTTP/1.1 Host: mysite.com User-Agent: Mozilla/5.0 (Windows NT 6.2; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/32.0.1667.0 Safari/537.36 Content-Type: application/x-www-form-urlencoded;charset=UTF-8 Content-Length: 29 Accept-Encoding: gzip grant_type=password username=test password=test

Example: Response

HTTP/1.1 200 OK
Status: 200 OK
Content-Type: application/json; charset=utf-8
...
Content-Encoding: gzip
Content-Length: 140
{"token_type":"bearer","access_token":"AAAA%2FAAA%3DAAAAAAAA"}

Sending request with tokens

Example: Request with token.

using (var client = new HttpClient())
{
	client.BaseAddress = new Uri("https://mysite.com/");
	client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token.ToString());
	var content = new MultipartFormDataContent();
	var filestream = new FileStream(path, FileMode.Open);
	content.Add(new StreamContent(filestream), "file", "Catalog.zip");
	var response = client.PostAsync("/episerverapi/commerce/import/catalog", content).Result;
	if (response.StatusCode == HttpStatusCode.OK)
	{
		var returnString = response.Content.ReadAsStringAsync().Result;
		returnString = returnString.Replace("\"", "");
		Guid taskId = Guid.Empty;
		Guid.TryParse(returnString, out taskId);
	}
}

Troubleshooting

The following common issues may arise when you set up the Service API.

  • Make sure there is a valid certificate on the server from a trusted certificate authority for the site.
  • Make sure all Service API requests are HTTPS.
  • You receive an error when trying to send a file to an import method. The Service API stores uploaded files in the AppDataPath set in the episerverframework.config file. Make sure the specified folder has the proper security permissions for the application pool identity.
  • Make sure there is a proper OWIN startup. You can disable this if there is a key on the appsettings.
    <add key="owin:AutomaticAppStartup" value="false" />

Next steps

Comments