API Keywords
5.4.1. Send API Request
Submitting a request to an API and that API retrieving the requested data from the external server or program and delivering it back to the client.
- Object Repository: The API service object.
- Data Input:
| Field | Description |
|---|---|
| request | Select an Object type API request from Object repository. |
- Data Output : Create or call a variable. Then result will return as shown in report below
- Click into the output variable "ResponseObject" then we get
5.4.2. Get Response Header
Get the specific value of Response's header.
- Object Repository: No Object Repository is required.
- Data Input:
| Field | Description |
|---|---|
| response | The response from API requested. |
| header | The specific value of response' header(example:Connection, Date, Content-Type...) |
- Data Output : Create or call a variable. Then result will return as shown in report below
5.4.3. Get Response Body
Get Response Body content of a Request.
- Object Repository: No Object Repository is required.
- Data Input:
| Field | Description |
|---|---|
| response | The response from API requested. |
- Data Output : Create or call a variable. Then result will return as shown in report below
5.4.4. Get Response Status Code
Get HTTP response status codes which indicate whether a specific HTTP request has been successfully completed.
- Object Repository: No Object Repository is required.
- Data Input:
| Field | Description |
|---|---|
| response | The response from API requested. |
- Data Output : Create or call a variable. Then result will return as shown in report below
5.4.5. Verify Response Header Value
Verify Response Header from a response.
- Object Repository: No Object Repository is required.
- Data Input:
| Field | Description |
|---|---|
| response | The response from API requested. |
| header | Name of the information you want to verify in the response header. |
| expectedHeaderValue | Expected value for the information. |
- Data Output : Create or call a variable. Then result will return as shown in report below
5.4.6. Verify Status Code
Verify expected status code from a response.
- Object Repository: No Object Repository is required.
- Data Input:
| Field | Description |
|---|---|
| response | The response from API requested. |
| expectedStatusCode | Expected value of the status code. |
- Data Output : Create or call a variable. Then result will return as shown in report below
