Documentation

Looking for something in particular?

Creating a Web Service Connection

To create a Simple Object Access Protocol (SOAP) or REpresentational State Transfer (REST) web service connection, navigate to the Connections tab of the Testing Settings view and click the green plus sign icon:

how to create a simple web service connection with SOAP or REST

Name the Connection, then select Connection Type: Generic Web Service. Select a sub-type of Rest Web Service or Soap Web Service.

If you are to create a web service connection (REST Connection), move on to the next section, or set up a SOAP Connection, skip ahead to SOAP Connections.

REST Connections


There are six types of REST Connections available:

  1. No Authentication: This is a curated list of APIs that do not require usernames, passwords, access tokens, signing, accept headers, or anything more complicated than putting a URL in a browser.
  2. Basic Authentication: In an HTTP transaction, basic access authentication is a method for an HTTP user agent to provide a username and password when requesting.
  3. API Key: To be used in cases where the user needs an API Key to process a REST request. You must provide the Resource URL and the API Key.
  4. Oauth(Client Credentials): This is one of 2 Oauth flows for processing a REST request. In this scenario, the user will need a URL, a Client Id, and Client Secret to process the request. For Internal (Salesforce) APIs, you can find the Client Id and Client Secret via Setup > Build > Apps.
  5. Oauth (Password): This is one of 2 Oauth flows for processing a REST Request. In this scenario, the user will need the above details (URL, Client Id, and Client Secret) and Username, Password, and Authorized URL to process the request.
  6. AWS Authentication: For AWS Authentication using AWS Signature Version 4. In this scenario, the user will need a URL, an Access Key, Secret Key, AWS Region, and Service Name.

Refer to Invoking the Connection for more information on using this Connection in a Test Case.

SOAP Connections


We need to provide the WSDL location for a SOAP Web Service Connection. The WSDL is defined at the SOAP Connection level, so it doesn’t need to be referenced continuously throughout the Test Case.

To locate the WSDL for the Web Service, log into Salesforce, then choose Setup > Develop > Apex Classes.

Locate the correct Apex Class and right-click on the WSDL link. Choose the Save link to download the XML file.

how to locate the correct Apex Class on the WSDL link

Save the downloaded XML file in the wsdl directory inside your Provar project (you may need to create this directory in Provar if it doesn’t already exist):

Note that it is recommended but not mandatory to store the WSDL in the Provar Project. If there is a good reason to store it elsewhere, it can still be referenced similarly in the Wsdl Location.

Then, define the Wsdl Location in the SOAP Connection. This can be done using a relative path or an absolute path, as below:

Once the Connection is saved, it will appear as follows:

For more information, check out this course on University of Provar.


Feedback

Was this article helpful for you?
Documentation library

Trying to raise a case with our support team?

We use cookies to better understand how our website is used so we can tailor content for you. For more information about the different cookies we use please take a look at our Privacy Policy.

Scroll to Top