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:
Give the Connection a name, 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 (as of version 1.9.7 and later):
- 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.
- Basic Authentication: In an HTTP transaction, basic access authentication is a method for an HTTP user agent to provide a username and password when making a request.
- API Key: To be used in cases where the user needs an API Key to process a REST request
- 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.
- 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) in addition to Username, Password, and Authorized URL to process the request.
- AWS Authentication (Provar version 1.9.7 and later): 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.
Click on the relevant REST Connection Type above and follow the steps in the relevant section.
No Authentication REST Connection
For a No Authentication Connection, we need to provide the basic domain URL, for example, http://services.groupkt.com.
Once the Connection is saved, it will appear as follows:
Refer to Invoking the Connection for more information on using this Connection in a Test Case.
Basic Authentication REST Connection
For a Basic Authentication Connection, we need to provide the Resource URL with a Username and Password.
Once the Connection is saved, it will appear as follows:
Refer to Invoking the Connection for more information on using this Connection in a Test Case.
API Key REST Connection
For an API Key Connection, we need to provide the Resource URL and the API Key.
Once the Connection is saved, it will appear as follows:
Refer to Invoking the Connection for more information on using this Connection in a Test Case.
OAuth (Client Credentials) REST Connection
For an OAuth (Client Credentials) Connection, we need to provide the Resource URL, Client Id, and Client Secret to create a web service connection.
For Internal (Salesforce) APIs, you can find the Client Id and Client Secret via Setup > Build > Apps.
For example:
Once the Connection is saved, it will appear as follows:
Refer to Invoking the Connection for more information on using this Connection in a Test Case.
OAuth (Password) REST Connection
For an OAuth (Password) Connection, we need to provide the Resource URL with Client Id, Client Secret, User, Password, and Authorized URL.
Once the Connection is saved, it will appear as follows:
Move on to Invoking the Connection for more information on using this Connection in a Test Case.
AWS Authentication Connection using AWS Signature Version 4 (Provar versions 1.9.7 and later)
We need to provide the URL, Access Key, Secret Key, AWS Region, and Service Name for an AWS Authentication. (Note that this option is available in Provar versions 1.9.7 and later).
For example:
Once the Connection is saved, it will appear as follows:
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.
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:
