Web service authentication in ECS Core refers to two areas:

  1. Authentication between the WebService Designer and ECS Core: This relates to the deployment of a web service to the ECS Core server.
  2. Authentication between a web service consumer and ECS Core: This relates to a web service call from a consumer app (i.e. cloud app, workflow etc.)

The following authentication methods are supported:

  • Authentication via API Key (recommended with https): A dedicated API Key created on the ECS Core Management Site is used for authentication.
  • Basic Authentication (recommended with https): Windows Basic Authentication is used for authentication.
  • Windows Authentication (NTLM): Use it for web service calls only if supported by the client. The local Windows User and password is used for authentication. This enables the service configurator to connect from any machine in the Active Directory, providing the account is recognized on the server where ECS Core is installed.
  • Authentication via Azure Service Bus: Authentication via Azure Service Bus is described separately here.

Authentication between the WebService Designer and ECS Core

When you want to use a web service created with the WebService Designer in the cloud you first have to deploy the web service to your ECS Core installation. The connection settings for the deployment in ECSCore have to be set in the Connection Dialog (Edit Connection button).

Connection settings with API Key:

Base URL: http://[ECS Core Server]:[ECS Core Services Site port (8080 by default)]
API Key: ECSCore API key (BASE64 encoded or not)

ecscore-webservices23

Connection settings with Basic Authentication

Base URL: http://[ECS Core Server]:[ECS CoreServices Site port (8080 by default)]
Username: Windows username
Password: Windows server password

ecscore-webservices21

Connection settings with Windows Authentication

Base URL: http://[ECS Core Server or localhost (when the designer is located on the same machine as ECS Core)]:[ECS Core Services Site port (8080 by default)]
Username: Can be left blank (local Windows User is used)
Password: Can be left blank (password for local Windows User is used)

ecscore-webservices29

With the Test button you can test the connection settings.

Authentication between a web service consumer and ECS Core

Between the web service consumer and ECS Core the same authentication methods are supported. The web service consumer can be for instance a REST client, a workflow, a JavaScript app, etc.

Setting the authentication for the the web service call ist described for the Postman REST Client here. These settings can be applied to REST web service calls in a workflow solution (i.e. Flow, Nintex). If you just want to test the functionality of a workflow quickly please use the web service operation test dialog.

General settings for REST web service calls in a REST Client

Web service method: POST
Web service URL: http(s)://[ECS Core Server]:[ECS Core Services Site port (8080 by default)]/wsd/[web service name]/[name of the web service operation]
Params: Scalar input parameters (will be added automatically to the URL)

Connection Settings with API key

Authorization:

Type: No Auth

Headers:

Authorization: APIKEY [BASE64 encoded ECSCore API key]
Accept: application/json (XML not supported)
Content-Type: application/json (XML not supported)

ecscore-webservices26

Connection settings with Basic Authentication

Authorization

Type: Basic Auth
Username: Windows username (supported with domain)
Password: Windows password

Headers

Authorization: Basic Key (Automatically generated)
Accept: application/json (XML not supported)
Content-Type: application/json (XML not supported)

ecscore-webservices24

ecscore-webservices25

Connection settings with Windows Authentication

Authorization

Type: NTLM Authentication
Username: Windows username
Password: Windows password
Domain (Optional): Domain name

Headers

Authorization: NTLM Key (Automatically generated)
Accept: application/json (XML not supported)
Content-Type: application/json (XML not supported)

ecscore-webservices30

ecscore-webservices31