HTTP request authentication

The /dms endpoints of Enterprise App Interface are designed for server-to-server communication, assuming a relatively secure transport channel between the ‘server’ (Enterprise App Interface) and ‘client’ (DMSConnector). Still, to prevent unauthorized access, every HTTP request sent to the /dms endpoints must contain a custom HTTP header called:

x-sps-api-key

The value of the header is a string. If the value provided in the x-sps-api-key header is not listed in the service configuration, the request will be rejected with HTTP 401-Unauthorized.

Configuring the accepted API keys is the responsibility of the service administrator.

See service settings for more information.

Example:

The following example shows how to set up a HttpClient object and configure it to send the custom x-sps-api-key header.

/* C# example */

// create a HttpClient object
HttpClient _AppInterfaceHttpClient = new HttpClient();

string dmsAPIKeyValue = "YOUR_DMS_API_KEY";

// configure HttpClient to send a header with all requests
_AppInterfaceHttpClient.DefaultRequestHeaders
    .Add("x-sps-api-key", dmsAPIKeyValue);