Search…
⌃K

Object Identification– API

Methods to identify objects for an API
Note:
  • Any header starting with ‘<’ is identified to be a SOAP API request and any header with ‘Content-type: application/json’ is classified as a REST API request.

SOAP APIs

  1. 1.
    Click on the screen name under 'My Tasks - To Do' of the Avo Assure Landing Page.
Landing Page – My Tasks Pane
2. Enter the WSDL URL and click on the Go button.
WDSL Operations
3. All the operations related to that WSDL URL will be listed in the Select Operation dropdown.
Select Operation dropdown
4. Select any operation and click on the Add button.
Operation Selection
5. Click on the ‘Add’ button. The sections EndpointUrl, Method, Operation, RequestHeader, and RequestBody get auto-populated.
Info Populated on Click of Add Button
6. Update the value in the Request body. If the request body is disabled, then click on the ‘Edit’ checkbox available in the Action Bar and update the request body.
Edit Checkbox and Value Updation in Request Body
Note: If it is not the first time that the screen has been accessed, then to populate the text fields, click on the ‘Edit’ checkbox which is below the ‘Web Services’ Scrape icon.
7. Click on Web Services icon to get the response header and body.
Web services Get Response
8. Click on the ‘Save’ button to save the Web Service template.
Webservice Template Saved – Success

REST APIs

  1. 1.
    Click on the screen name under ‘My Tasks - To Do’ of the Avo Assure Landing Page.
Landing Page – My Tasks Pane
2. Enter the End Point URL.
Specify End Point URL.
3. Select the method of the API.
Select API Method
4. Populate the request header and the request body (if needed).
Populate request header
Note:
  • If it is not the first time that the screen has been accessed, then to populate the text fields, click on the ‘Edit’ checkbox which is below the ‘Web Services’ Scrape icon.
  • For REST APIs, the request body must contain “content-type: application/json”.
Populate request body (usually, for API’s with POST Method)
5. If needed, set the params for the API by clicking on the ‘Params’ tab and specifying the params and their values.
Set API Params
Note:
  • Params should be passed in the following method: param_name = param_value.
  • If there are multiple params, then these should be passed in multiple lines.
6. Click on the scrape icon for Web Services.
Scrape Webservices object (without request body)
Scrape Webservices object (with request body)
7. Click on the ‘Web Services’ icon to begin the API execution. The user will be prompted with the following pop-up.
API Execution Status pop-up
8. Click on the 'Response' tab to view the response received.
Web services Get Response
9. Click on the ‘Save’ button to save the Web Service template.
Save Webservice Template

Certificate Authentication

Avo Assure supports Web Service certificate authentication.
  1. 1.
    Click on the certificate icon to add a certificate to the template.
Add Certificate
2. Click on the Add Certificate icon. The Add Certificate pop-up is displayed.
Add Certificate Pop-up
  • Field 1: < Enter the local file path of the certificate file >;< if the certificate is paired with a key then the key has to be provided here >
  • Field 2: < Enter the certificate password which needs to be generated using Avo Assure encryption utility with AES type >;< if the server certificate is available then its file path has to be provided here >
  • Field 3: < Authentication username has to be provided here >
  • Field 4: < Authentication password has to be provided here which has to be generated using Avo Assure encryption utility with AES type >
  • Submit: When submitted, it saves the details provided and performs the authentication while fetching the response.
Avo Assure supports jks, pem, pkcs12, and pfx certificate types.