Skip to content

Web Service Endpoints ​

A web service endpoint describes a REST or other HTTP service that workflows call: where it is and how requests are authenticated.

Creating or Editing a Web Service Endpoint ​

Right-click Endpoints and select New Endpoint > Web Service, or right-click an existing web service endpoint and select Edit. See Endpoints.

Add/Edit Endpoint - Web Service

Settings ​

SettingDescription
Endpoint NameA unique name to identify this endpoint within Situate.
DescriptionA helpful description of the endpoint. Required.
Access Through AssetThe asset whose agent makes the requests. Usually XonaServer, the Situate server.
URLThe service's base URL, in the form https://host:port (or http: for an unsecured service).
AuthenticationHow requests are authenticated. See below.

Authentication ​

AuthenticationWhat Situate does
NoneSends requests without credentials
BasicSends HTTP basic authentication. The login and password come from the workflow user's credentials for this endpoint
API KeySends the workflow user's API key for this endpoint in the header named in Key header (for example, auth)
API Key and Secret KeySends the API key in the header named in Key header, and signs each request with the secret key (see below)

The login, password and keys aren't stored in the endpoint. Each user or service account that calls the service needs an Endpoint specific authentication identity for this endpoint. See Identities.

Signed Requests ​

With API Key and Secret Key, Situate also adds a signature to each request:

SettingMeaning
SignatureWhere the signature goes: Append to URL as query parameter (enter the parameter name) or Add header (enter the header name)
AlgorithmSHA-256 Sum, or SHA-256 HMAC w. Secret Key
Compute asThe text the signature is computed from, as the service's documentation describes it

Testing ​

Web service endpoints have no Test button. To check the settings, run a workflow that calls the service.

Workload Automation and Orchestration