Skip to main content

Get help for ARIS Process Mining functions and services

Create an HTTP connection

Create an HTTP connection to provide a base URL and the required authentication data for an HTTP extraction. The HTTP extraction uses the connection data for extracting data from source systems via HTTP REST-APIs.

Note that if you want to use OAuth2 for authentication, you must first specify the token endpoint URL to receive the required REST-API base URL.

Procedure. Procedure

  1. Open a data set.

  2. Click Connections in the Data set panel. The Connections section opens.

  3. Click Add connection. If you add a connection to a source system for the first time and you have not assigned a license to the data set yet, the Assign ‘Living Process’ license dialog opens. Assign a 'Living Process' license to the data set.

  4. Configure the connection.

    1. Enter a unique name for the connection to the source system.

    2. Specify a REST-API base URL. The base URL is the constant part or the root of your Web application's API. All API endpoints are relative to the base URL.

      If you want to use OAuth2 for authentication, you must first select OAuth2 as the authentication method and specify the access data (see the next step). Then click Test connection to receive an access token using the OAuth client credentials. This access token is used to authenticate a request to the base URL and verify connectivity via secure bearer authentication.

      Example

      https://example.com/api

    3. Select an authentication method for accessing the data source from the relevant drop-down menu.

      Select No authentication if no authentication is required. The option is preset as default.

      Select Basic authentication if a user name and password are required. Enter a user name and password.

      Select Bearer token authentication if a bearer token is required. Enter a bearer token.

      Select OAuth2 if the client credentials method for authentication is required. Enter a token endpoint URL (for example, https://example.com/oauth_token.do), and the client ID and a client secret that are required to access the token endpoint. If required, specify a scope to access the data source system.

      Client credentials-based authentication methods are designed for scenarios without user context and are best suited for machine-to-machine communication.

    4. Click Test connection to check whether the settings are correct and the data source can be reached. To do this, you must specify a test-connection resource in the corresponding input field. If you selected the OAuth2 authentication method, the REST-API base URL is received by the access server and automatically entered in the corresponding input field.

      Example

      /resource/1

      The connection is considered successful if it returns a response with a status code in the range of 200 to 299.

    5. Click Add.

You created an HTTP connection to a data source. The connection is added to the Connections list.

You can use the HTTP connection to create an HTTP extraction.