REST API Functions
Sahi exposes RESTRequest and RESTResponse APIs to work with REST APIs
RESTRequest
Section titled “RESTRequest”- Since
- Sahi Pro 5.1.0
Modes Browser
RESTRequest()Arguments
| Name | Type | Description |
|---|---|---|
None |
Returns
null |
RESTRequest object is used to REST requests
RESTRequest.addToQueryString
Section titled “RESTRequest.addToQueryString”- Since
- Sahi Pro 5.1.0
Modes Browser
RESTRequest.addToQueryString($key, $value)Arguments
| Name | Type | Description |
|---|---|---|
$key | string | query parameter key |
$value | string | query parameter value |
Returns
null |
Adds a query parameter to the request URL
$request = new RESTRequest();$request.addToQueryString("Place", "Bangalore");Single argument can also be passed to this function. This can be a string which is queryString or Parameter object. Parameter object is explained below.
-
As query string
$request = new RESTRequest();$request.addToQueryString("Place=Bangalore"); -
As Parameter object
$request = new RESTRequest();var $p = new Parameter();$p.add("Name", "Jane");$p.add("Age", "25");$request.addToQueryString($p);
RESTRequest.addToBody
Section titled “RESTRequest.addToBody”- Since
- Sahi Pro 5.1.0
Modes Browser
RESTRequest.addToBody($key, $value)Arguments
| Name | Type | Description |
|---|---|---|
$key | string | query parameter key |
$value | string | query parameter value |
Returns
null |
Adds a query parameter to the request Body
$request = new RESTRequest();$request.addToBody("Place", "Bangalore");Single argument can also be passed to this function. This can be a string which is queryString or Parameter object. Parameter object is explained below.
-
As query string
$request = new RESTRequest();$request.addToBody("Place=Bangalore"); -
As Parameter object
$request = new RESTRequest();var $p = new Parameter();$p.add("Name", "Jane");$p.add("Age", "25");$request.addToBody($p);
RESTRequest.setHeader
Section titled “RESTRequest.setHeader”- Since
- Sahi Pro 5.1.0
Modes Browser
RESTRequest.setHeader($key, $value)Arguments
| Name | Type | Description |
|---|---|---|
$key | string | Header name |
$value | string | Header value |
Returns
null |
Sets request header
$request = new RESTRequest();$request.setHeader("Accept-Encoding", "deflate,sdch");RESTRequest.setURL
Section titled “RESTRequest.setURL”- Since
- Sahi Pro 5.1.0
Modes Browser
RESTRequest.setURL($url)Arguments
| Name | Type | Description |
|---|---|---|
$url | string | url to be navigated |
Returns
null |
Sets url to be navigated
$request = new RESTRequest();$request.setURL("http://sahi.co.in");RESTRequest.setBody
Section titled “RESTRequest.setBody”- Since
- Sahi Pro 6.0.0
Modes Browser
RESTRequest.setBody($body)Arguments
| Name | Type | Description |
|---|---|---|
$body | string | the body of the request. |
Returns
null |
Sets body of the request. Pass a JSON string.
var $json = { "firstName": "John", "lastName": "Smith", "age": 25, "address": { "streetAddress": "21 2nd Street", "city": "Mumbai" }};var $jsonString = JSON.stringify($json);
$request = new RESTRequest();$request.setBody($jsonString);RESTRequest.setCredentials
Section titled “RESTRequest.setCredentials”- Since
- Sahi Pro 6.0.0
Modes Browser
RESTRequest.setCredentials($username, $password[, $isEncrypted])Arguments
| Name | Type | Description |
|---|---|---|
$username | string | Username for authentication |
$password | string | Password for authentication |
$isEncrypted | booleanoptional | Set as true if the password is encrypted |
Returns
null |
Sets authentication parameters when trying to access an authorized page. Uses the credentials provided for 401 Authentication.
$request = new RESTRequest();$request.setCredentials("testuser", "password");
// Use encrypted password$request = new RESTRequest();$request.setCredentials("testuser", "MgkKEQBU", true);RESTRequest.setAuthCredentials
Section titled “RESTRequest.setAuthCredentials”- Since
- Sahi Pro 7.0.0
Modes Browser
RESTRequest.setAuthCredentials($oauthtype, $oauthvalue[, $isEncrypted])Arguments
| Name | Type | Description |
|---|---|---|
$oauthtype | string | oauthtype for authentication |
$oauthvalue | string | oauthvalue for authentication |
$isEncrypted | booleanoptional | Set as true if the oauthvalue is encrypted |
Returns
null |
Sets authentication parameters when trying to access an authorized page. Uses the credentials provided for Basic/oAuth1.0 Authentication.
// For Basic auth$request = new RESTRequest();$request.setAuthCredentials("authType", "Basic Auth");$request.setAuthCredentials("userName", "testuser");$request.setAuthCredentials("passWord", "password");
// For Basic auth with encrypted password$request = new RESTRequest();$request.setAuthCredentials("authType", "Basic Auth");$request.setAuthCredentials("userName", "testuser");$request.setAuthCredentials("passWord", "MgkKEQBU", true);
// For oAuth1.0$request = new RESTRequest();$request.setAuthCredentials("authType", "OAuth 1.0");$request.setAuthCredentials("oauth_consumer_key", "consumer key");$request.setAuthCredentials("oauth_consumer_secret", "consumer secret");$request.setAuthCredentials("oauth_token", "token");$request.setAuthCredentials("oauth_token_secret", "token secret");$request.setAuthCredentials("oauth_signature_method", "HMAC-SHA1");$request.setAuthCredentials("oauth_version", "1.0");RESTRequest.submit
Section titled “RESTRequest.submit”- Since
- Sahi Pro 5.1.0
Modes Browser
RESTRequest.submit($method[, $followRedirects])Arguments
| Name | Type | Description |
|---|---|---|
$method | string | request method, values can be "get", "post" or "delete" |
$followRedirects | booleanoptional | Set this argument to false if the request should not automatically follow redirects. The default value is true. This argument is available since Sahi Pro v10.0.0. |
Returns
object | RESTResponse object |
Submits the request, reads response and returns a RESTResponse object
$request = new RESTRequest();$request.setURL("http://sahi.co.in");$response = $request.submit("get");If this function is called before setURL it will return a null object
RESTResponse
Section titled “RESTResponse”- Since
- Sahi Pro 5.1.0
Modes Browser
RESTResponse()Arguments
| Name | Type | Description |
|---|---|---|
None |
Returns
null |
RESTResponse object is used to read REST responses
RESTResponse.getResponseCode
Section titled “RESTResponse.getResponseCode”- Since
- Sahi Pro 5.1.0
Modes Browser
RESTResponse.getResponseCode()Arguments
| Name | Type | Description |
|---|---|---|
None |
Returns
string | Response code |
var $s = $response.getResponseCode(); //returns response code e.g. 200, 404 etc.RESTResponse.getHeader
Section titled “RESTResponse.getHeader”- Since
- Sahi Pro 5.1.0
Modes Browser
RESTResponse.getHeader($key)Arguments
| Name | Type | Description |
|---|---|---|
$key | string | Header name |
Returns
string | Value of the specified response header |
var $s = $response.getHeader("Content-Length"); //returns value of content-length headerRESTResponse.getBodyAsString
Section titled “RESTResponse.getBodyAsString”- Since
- Sahi Pro 5.1.0
Modes Browser
RESTResponse.getBodyAsString([$charSet])Arguments
| Name | Type | Description |
|---|---|---|
$charSet | stringoptional | Character set. Default is "UTF-8". |
Returns
string | Content of response body |
NOTE: $charSet was added Since Sahi Pro: 6.2.1. For old document Refer here
var $s = $response.getBodyAsString(); //returns the content of the body using UTF-8 encodingvar $s = $response.getBodyAsString("ISO-8859-1"); //returns the content of the body using ISO-8859-1 encodingRESTResponse.getBody
Section titled “RESTResponse.getBody”- Since
- Sahi Pro 5.1.0
Modes Browser
RESTResponse.getBody()Arguments
| Name | Type | Description |
|---|---|---|
None |
Returns
array | Content of response body as byte array |
var $s = $response.getBody(); //returns the content of the bodyParameter
Section titled “Parameter”- Since
- Sahi Pro 5.1.0
Modes Browser
Parameter()Arguments
| Name | Type | Description |
|---|---|---|
None |
Returns
null |
Parameter object is used to add parameters to query string and body
Parameter.add
Section titled “Parameter.add”- Since
- Sahi Pro 5.1.0
Modes Browser
Parameter.add($key, $value)Arguments
| Name | Type | Description |
|---|---|---|
$key | string | parameter key |
$value | string | parameter value |
Returns
null |
Adds a key-value pair to Parameter object
var $p = new Parameter();$p.add("Name", "Jane");Parameter.replace
Section titled “Parameter.replace”- Since
- Sahi Pro 8.0.0
Modes Browser
Parameter.replace($key, $value[, $index])Arguments
| Name | Type | Description |
|---|---|---|
$key | string | parameter key |
$value | string | parameter value |
$index | integeroptional | parameter Index |
Returns
null |
Replace a key-value pair at a specified index in the Parameter object. If the index is not specified the all the values added previously will be replaced by the value specified.
var $p = new Parameter();$p.add("Name", "Jane");$p.add("Name", "Woo");$p.replace("Name", "Doe", 1);$p.getQueryString(); // returns Name=Jane&Name=DoeParameter.remove
Section titled “Parameter.remove”- Since
- Sahi Pro 5.1.0
Modes Browser
Parameter.remove($key)Arguments
| Name | Type | Description |
|---|---|---|
$key | string | parameter key |
Returns
null |
Removes a key-value pair(if exists) from Parameter object, specified by the key
var $p = new Parameter();$p.add("Name", "Jane");$p.add("Age", "25");$p.remove("Name");Parameter.getQueryString
Section titled “Parameter.getQueryString”- Since
- Sahi Pro 5.1.0
Modes Browser
Parameter.getQueryString()Arguments
| Name | Type | Description |
|---|---|---|
None |
Returns
string | query string |
Creates a query string using all the key-value pairs in the Parameter object
var $p = new Parameter();$p.add("Name", "Jane");$p.add("Age", "25");var $qs = $p.getQueryString();
