› Integration › Web service references › Create a web service reference › Create a RESTful web service reference

Create a RESTful web service reference

Create a RESTful web service reference by doing the following.

  1. On the Web service references page, select New.

    The New web service reference dialog box is displayed.

  2. On the Service type list, select RESTful.
  3. Enter a Name for the web service.
  4. By default, the system automatically saves a new web service reference in your working category. To store the web service reference in a different category, select a category on the Category list.

    The categorization of web services helps restrict their access to specific users.

  5. Specify the URL that maps the HTTP methods: GET, PUT, POST, PATCH, and DELETE. See RESTful Service activity and Configure a RESTful Service activity.
    If the "Allow all" system setting is disabled, you can only provide a whitelisted web service URL. If the URL connection string is not whitelisted, the connection is denied. See Whitelist a web service URL or a database connection string.
  6. By default, the "Expect: 100-continue" header is included for POST RESTful API calls. If you need to send POST requests without this header, select Remove Expect 100-Continue header.
  7. You can control access to the web service and not just restrict access to the configured TotalAgility Enterprise services account.
    1. Select one of the following options for Authentication:

      Option Description

      Basic

      Enter the User name and Password for the endpoint.

      OAuth

      Select the OAuth server on the OAuth server list.

      • When a RESTful web service with an integrated OAuth server is executed (using a process map or form), any expired access tokens are automatically refreshed for a successful web service execution. This does not apply to the OAuth servers for which access tokens are not generated.

      • When you export and import a process map or a form that has a RESTful service type, you can also export and import the associated OAuth servers.

      Certificate

      1. Browse and upload or drag the certificate here to use to authenticate with the web service.

      2. Enter the Certificate password.

        If the certificate is not valid, an error is displayed at runtime.

      3. To view the certificate details, such as Issued to, Issued by, and Validity period, select View certificate, enter the password, and then select Get details.

      OAuth and certificate

      		Select this option to support both OAuth and Client certificate for authentication.

      1. Upload the certificate.

      2. To view the certificate details, such as Issued to, Issued by, and Validity period, select View certificate, enter the password, and then select Get details.

      3. Select the OAuth server on the OAuth server list.

      Basic (external)

      Enter the secret name for the username and password stored in the configured external storage.

      Default (Default)

      Uses the Windows credentials of the TotalAgility service account user.

      When the RESTful service is executed through a process or form with Default authentication configured, the account running the TotalAgility services is passed during the web service call.

  8. Optional. You can enhance your RESTful web service security by providing up to three server certificate thumbprints for validating the server certificate during the TLS handshake - Under Server certificate validation, in the Certificate thumbprint 1 box, enter the thumbprint of the server certificate. Add more thumbprints as needed.

    Specifying multiple trusted thumbprints maximizes the likelihood of successful, secure server certificate verification.

  9. Add a custom header.
  10. Select Save.
    If the service is valid, TotalAgility Advanced Studio generates a proxy stub DLL.