REST API Editor

Launching the REST Client

REST Client can be launched by clicking on the REST Client link from Editor.

REST Request

REST request can be entered by one of the following ways:

Manual Input

Specify the following request parts as applicable:

• HTTP Method: Select a HTTP method from drop down.
• URL: Enter the REST API URL.
• Parameters: Enter the parameters which will go as query string along with URL.
• HTTP Headers
• Authorization: See Authorization section for details
• Body: The body part can be specified for a POST, PUT and PATCH request

Enter the required fields and click on 'Send Request' button to submit the request and get response.

Import from HAR

• Click on Import request from HAR button.

• Paste the request section of the response to be validated from HAR logs and click on Import

infoNote: Request section from HAR logs should be in JSON format. Check for opening and closing braces, else an alert would show up.
info

Note:
• HAR logs can be accessed from developer's console > Network activity > Right click > save HAR.
• A sample request section from HAR logs would look like:

  {
  "request": {
            "method": "GET",
            "url": "http://sahitest.com/demo/",
            "httpVersion": "HTTP/1.1",
            "headers": [
              {
                "name": "Host",
                "value": "sahitest.com"
              },
              {
                "name": "Connection",
                "value": "keep-alive"
              },
              {
                "name": "Cache-Control",
                "value": "max-age=0"
              },
              {
                "name": "DNT",
                "value": "1"
              },
              {
                "name": "Upgrade-Insecure-Requests",
                "value": "1"
              },
            ],
            "queryString": [],
            "cookies": [],
            "headersSize": 585,
            "bodySize": 0
          }
  }

Import from network activity in Sahi logs

• Record HAR for a network activity using _startHarLogging() and _stopHarLogging() in Sahi script
• Click on Show Network Activity from the logs

• Click on Copy HAR button to copy request parameters as HAR. Then paste the logs in Import request from HAR window as mentioned above in Entering the HAR logs in Import request from HAR window

REST Response

REST Response section displays following information:

1. Response Status: Displays the response code returned by the server.
2. Response Header: Displays the response headers returned by the server.
3. Response Body: Response Body has 3 tabs:
• Raw: Displays the response body as it is returned.

• HTML: Displays the parsed HTML if content type returned from server is HTML.

• TREE: Displays the response body in tree structure if content type returned from server is JSON or XML.

Generate Script

Select the parameters which has to be validated by selecting the checkboxes and click on Generate Sahi Script button. For example: select Response Status, Content Type from Request Headers and place_id from Reponse Body and click on Generate Sahi Script.

Authorization

Basic Auth

Enter the username and password after selecting Basic Auth from dropdown.

OAuth 1.0:

Choose OAuth 1.0 from the Authorization dropdown.

Credentials: Select an already saved credential or select Add New from credentials dropdown to add a new credential. Enter a friendly name to save these credentials against. Enter the Consumer Key, Consumer Secret, Token, Token Secret. These details are provided by the API provider.

Signature Method: Sahi currently supports HMAC-SHA1 and HMAC-SHA256 signature methods.

Version: Enter the version as required by the API under test.

Realm: Enter the realm as required by the API under test.

OAuth 2.0

References:

OAuth 2 RFC	https://tools.ietf.org/html/rfc6749
REST API	https://techdocs.ed-fi.org/display/ETKB/REST+API+Guidelines+v2.0+RFC

1. Sahi's OAuth 2 automation can be accessed from the Authorization drop down as shown in the picture below.
2. This shows the Access Token field.
3. If you already have a token you can use that to proceed with the API calls. If you do not have an Access Token, click on Get Access Token ... to open the OAuth 2.0 Consent and Access Token Wizard
4. Choose one of the options:

   Option	Use
   Access Token without Playback/Recording	Choose this if you are just playing around with the REST API and are not intending to record a script
   Playback of recorded consent script	Choose this if you already have a recorded consent script which enters the relevant data in a browser window to get the Access Token. You may need this to test different APIs by the same provider
   Record a new consent script	Use this to record the flow on the browser to get the Access Token. This recorded Sahi script is called the consent script
   Using Refresh Token	Use this option if you have a refresh token

5. Select the Record a new consent script option from the wizard
6. Give the consent script a name.
7. Once you click on Proceed, a new browser window will be opened and you will be prompted for authorization information.
8. You will be redirected to the Login page provided by the authorization endpoint where you have to provide the username, password and permissions to allow access to the user's resources
9. You will be now prompted with Access Token Request Input form where the Authorization code will be prefilled. Fill rest of the details and click on Get Access Token
10. After the access token request is successful, the Access Token field in the REST Client UI will be updated
11. Click on the Send Request button. The Service Endpoint will respond with the API result

Uploading a file using REST Client

 

 

Steps:

1. Open the Editor from the Sahi Dashboard
2. Open REST Client by clicking on the More drop down menu

3. Select the POST from HTTP Method combo box

4. Specify the file upload URL in the URL field

5. Specify the Content-Type header in the HTTP Headers table

6. Specify the POST fields
1. Specify the file to be uploaded, you can use the browse  button
2. Specify other body parameters if required, for example on above case, the file upload test application requires 2 other fields for the upload to work

7. Click on the Send Request button
8. You will get the following result after the file upload, the response may defer depending on the web application